DataTransferKit - Multiphysics Solution Transfer Services  2.0
Public Types | Public Member Functions | List of all members
DataTransferKit::EntityCenteredField Class Reference

Entity-centered field. More...

#include <DTK_EntityCenteredField.hpp>

Inheritance diagram for DataTransferKit::EntityCenteredField:
DataTransferKit::Field

Public Types

Public Member Functions

 EntityCenteredField (const Teuchos::ArrayView< Entity > &entities, const int field_dim, const Teuchos::ArrayRCP< double > &dof_data, const DataLayout layout)
 Entity constructor. More...
 
 EntityCenteredField (const Teuchos::ArrayView< const EntityId > &entity_ids, const int field_dim, const Teuchos::ArrayRCP< double > &dof_data, const DataLayout layout)
 Entity id constructor. More...
 
int dimension () const
 Get the dimension of the field. More...
 
Teuchos::ArrayView< const SupportIdgetLocalSupportIds () const
 Get the locally-owned support location ids of the field. More...
 
double readFieldData (const SupportId support_id, const int dimension) const
 Given a local dof id and a dimension, read data from the application field. More...
 
void writeFieldData (const SupportId support_id, const int dimension, const double data)
 Given a local dof id, dimension, and field value, write data into the application field. More...
 
- Public Member Functions inherited from DataTransferKit::Field
 Field ()
 Constructor. More...
 
virtual ~Field ()
 Destructor. More...
 
virtual void finalizeAfterWrite ()
 Finalize a field after writing into it. This lets some clients do a post-process (e.g. update ghost values). Default finalize does nothing. More...
 

Detailed Description

Entity-centered field.

Field implementation for basic geometry fields over entities. Input data is 1D but ordered in 2D such that entity 'e' has for dimension 'd' a value of:

BLOCKED: data[d][e]

INTERLEAVED: data[e][d]

Set the value of data layout in the constructor.

Definition at line 72 of file DTK_EntityCenteredField.hpp.

Member Enumeration Documentation

Blocked/Interleaved data layout enum.

Definition at line 76 of file DTK_EntityCenteredField.hpp.

Constructor & Destructor Documentation

DataTransferKit::EntityCenteredField::EntityCenteredField ( const Teuchos::ArrayView< Entity > &  entities,
const int  field_dim,
const Teuchos::ArrayRCP< double > &  dof_data,
const DataLayout  layout 
)

Entity constructor.

Definition at line 48 of file DTK_EntityCenteredField.cpp.

DataTransferKit::EntityCenteredField::EntityCenteredField ( const Teuchos::ArrayView< const EntityId > &  entity_ids,
const int  field_dim,
const Teuchos::ArrayRCP< double > &  dof_data,
const DataLayout  layout 
)

Entity id constructor.

Definition at line 68 of file DTK_EntityCenteredField.cpp.

Member Function Documentation

int DataTransferKit::EntityCenteredField::dimension ( ) const
virtual

Get the dimension of the field.

Implements DataTransferKit::Field.

Definition at line 88 of file DTK_EntityCenteredField.cpp.

Teuchos::ArrayView< const SupportId > DataTransferKit::EntityCenteredField::getLocalSupportIds ( ) const
virtual

Get the locally-owned support location ids of the field.

Implements DataTransferKit::Field.

Definition at line 93 of file DTK_EntityCenteredField.cpp.

double DataTransferKit::EntityCenteredField::readFieldData ( const SupportId  support_id,
const int  dimension 
) const
virtual

Given a local dof id and a dimension, read data from the application field.

Implements DataTransferKit::Field.

Definition at line 101 of file DTK_EntityCenteredField.cpp.

void DataTransferKit::EntityCenteredField::writeFieldData ( const SupportId  support_id,
const int  dimension,
const double  data 
)
virtual

Given a local dof id, dimension, and field value, write data into the application field.

Implements DataTransferKit::Field.

Definition at line 113 of file DTK_EntityCenteredField.cpp.


The documentation for this class was generated from the following files: