DataTransferKit - Multiphysics Solution Transfer Services  2.0
Public Member Functions | List of all members
DataTransferKit::STKMeshField< Scalar, FieldType > Class Template Reference

Field data access for STK mesh. More...

#include <DTK_STKMeshField.hpp>

Inheritance diagram for DataTransferKit::STKMeshField< Scalar, FieldType >:
DataTransferKit::Field

Public Member Functions

 STKMeshField (const Teuchos::RCP< stk::mesh::BulkData > &bulk_data, const Teuchos::Ptr< FieldType > &field, const int field_dim)
 Constructor. More...
 
int dimension () const override
 Get the dimension of the field. More...
 
Teuchos::ArrayView< const SupportIdgetLocalSupportIds () const override
 Get the locally-owned entity support location ids of the field. More...
 
double readFieldData (const SupportId support_id, const int dimension) const override
 Given a local support id and a dimension, read data from the application field. More...
 
void writeFieldData (const SupportId support_id, const int dimension, const double data) override
 Given a local support id, dimension, and field value, write data into the application field. More...
 
void finalizeAfterWrite () override
 Finalize a field after writing into it. More...
 
- Public Member Functions inherited from DataTransferKit::Field
 Field ()
 Constructor. More...
 
virtual ~Field ()
 Destructor. More...
 

Detailed Description

template<class Scalar, class FieldType>
class DataTransferKit::STKMeshField< Scalar, FieldType >

Field data access for STK mesh.

Definition at line 68 of file DTK_STKMeshField.hpp.

Constructor & Destructor Documentation

template<class Scalar , class FieldType >
DataTransferKit::STKMeshField< Scalar, FieldType >::STKMeshField ( const Teuchos::RCP< stk::mesh::BulkData > &  bulk_data,
const Teuchos::Ptr< FieldType > &  field,
const int  field_dim 
)

Constructor.

Definition at line 61 of file DTK_STKMeshField_impl.hpp.

Member Function Documentation

template<class Scalar , class FieldType >
int DataTransferKit::STKMeshField< Scalar, FieldType >::dimension ( ) const
overridevirtual

Get the dimension of the field.

Implements DataTransferKit::Field.

Definition at line 109 of file DTK_STKMeshField_impl.hpp.

template<class Scalar , class FieldType >
Teuchos::ArrayView< const SupportId > DataTransferKit::STKMeshField< Scalar, FieldType >::getLocalSupportIds ( ) const
overridevirtual

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

Implements DataTransferKit::Field.

Definition at line 118 of file DTK_STKMeshField_impl.hpp.

template<class Scalar , class FieldType >
double DataTransferKit::STKMeshField< Scalar, FieldType >::readFieldData ( const SupportId  support_id,
const int  dimension 
) const
overridevirtual

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

Implements DataTransferKit::Field.

Definition at line 128 of file DTK_STKMeshField_impl.hpp.

template<class Scalar , class FieldType >
void DataTransferKit::STKMeshField< Scalar, FieldType >::writeFieldData ( const SupportId  support_id,
const int  dimension,
const double  data 
)
overridevirtual

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

Implements DataTransferKit::Field.

Definition at line 141 of file DTK_STKMeshField_impl.hpp.

template<class Scalar , class FieldType >
void DataTransferKit::STKMeshField< Scalar, FieldType >::finalizeAfterWrite ( )
overridevirtual

Finalize a field after writing into it.

Reimplemented from DataTransferKit::Field.

Definition at line 153 of file DTK_STKMeshField_impl.hpp.


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