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

High-level manager for STK mesh. More...

#include <DTK_STKMeshManager.hpp>

Inheritance diagram for DataTransferKit::STKMeshManager:
DataTransferKit::ClientManager

Public Types

Public Member Functions

 STKMeshManager (const Teuchos::RCP< stk::mesh::BulkData > &bulk_data, const BasisType basis_type=BASIS_TYPE_GRADIENT)
 Default constructor. More...
 
 STKMeshManager (const Teuchos::RCP< stk::mesh::BulkData > &bulk_data, const Teuchos::Array< std::string > &part_names, const BasisType basis_type=BASIS_TYPE_GRADIENT)
 Part name constructor. More...
 
 STKMeshManager (const Teuchos::RCP< stk::mesh::BulkData > &bulk_data, const stk::mesh::PartVector &parts, const BasisType basis_type=BASIS_TYPE_GRADIENT)
 Part vector constructor. More...
 
 STKMeshManager (const Teuchos::RCP< stk::mesh::BulkData > &bulk_data, const stk::mesh::Selector &selector, const BasisType basis_type=BASIS_TYPE_GRADIENT)
 Selector constructor. More...
 
template<class FieldType >
void registerField (const Teuchos::Ptr< FieldType > &field, const int field_dim)
 Register a tag with the manager that will be available for solution transfer. More...
 
Teuchos::RCP< FunctionSpace > functionSpace () const
 Get the function space over which the mesh and its fields are defined. More...
 
template<class FieldType >
Teuchos::RCP< FieldMultiVector > createFieldMultiVector (const Teuchos::Ptr< FieldType > &field, const int field_dim)
 Given a field and dimension, build a vector over that field. More...
 
Teuchos::RCP< EntitySetentitySet () const override
 ClientManager interface implementation. More...
 
Teuchos::RCP< EntityLocalMaplocalMap () const override
 Get the local map for entities supporting the function. More...
 
Teuchos::RCP< EntityShapeFunctionshapeFunction () const override
 Get the shape function for entities supporting the function. More...
 
Teuchos::RCP< EntityIntegrationRuleintegrationRule () const override
 Get the integration rule for entities supporting the function. More...
 
PredicateFunction selectFunction () const override
 Get the selector function. More...
 
Teuchos::RCP< Fieldfield (const std::string &field_name) const override
 Get the field for the given string key. More...
 
- Public Member Functions inherited from DataTransferKit::ClientManager
 ClientManager ()
 Constructor. More...
 
virtual ~ClientManager ()
 Destructor. More...
 

Detailed Description

High-level manager for STK mesh.

This manager provides a high-level class for automated construction of DTK interface objects. A user is not required to use this class but rather could use it to reduce code for certain implementations.

Definition at line 73 of file DTK_STKMeshManager.hpp.

Member Enumeration Documentation

Basis type enum.

Definition at line 79 of file DTK_STKMeshManager.hpp.

Constructor & Destructor Documentation

DataTransferKit::STKMeshManager::STKMeshManager ( const Teuchos::RCP< stk::mesh::BulkData > &  bulk_data,
const BasisType  basis_type = BASIS_TYPE_GRADIENT 
)

Default constructor.

Parameters
bulk_dataSTK mesh bulk data.
entity_typeThe type of entities in the mesh that will be mapped.
basis_typeThe type of basis function space to use.

Definition at line 52 of file DTK_STKMeshManager.cpp.

DataTransferKit::STKMeshManager::STKMeshManager ( const Teuchos::RCP< stk::mesh::BulkData > &  bulk_data,
const Teuchos::Array< std::string > &  part_names,
const BasisType  basis_type = BASIS_TYPE_GRADIENT 
)

Part name constructor.

Parameters
bulk_dataSTK mesh bulk data.
part_namesThe names of the parts in the STK mesh that will be mapped.
entity_typeThe type of entities in the mesh that will be mapped.
basis_typeThe type of basis function space to use.

Definition at line 63 of file DTK_STKMeshManager.cpp.

DataTransferKit::STKMeshManager::STKMeshManager ( const Teuchos::RCP< stk::mesh::BulkData > &  bulk_data,
const stk::mesh::PartVector &  parts,
const BasisType  basis_type = BASIS_TYPE_GRADIENT 
)

Part vector constructor.

Parameters
bulk_dataSTK mesh bulk data.
part_vectorThe parts in the STK mesh that will be mapped.
entity_typeThe type of entities in the mesh that will be mapped.
basis_typeThe type of basis function space to use.

Definition at line 75 of file DTK_STKMeshManager.cpp.

DataTransferKit::STKMeshManager::STKMeshManager ( const Teuchos::RCP< stk::mesh::BulkData > &  bulk_data,
const stk::mesh::Selector &  selector,
const BasisType  basis_type = BASIS_TYPE_GRADIENT 
)

Selector constructor.

Parameters
bulk_dataSTK mesh bulk data.
selectorSelector fo the parts in the STK mesh that will be mapped.
entity_typeThe type of entities in the mesh that will be mapped.
basis_typeThe type of basis function space to use.

Definition at line 87 of file DTK_STKMeshManager.cpp.

Member Function Documentation

template<class FieldType >
void DataTransferKit::STKMeshManager::registerField ( const Teuchos::Ptr< FieldType > &  field,
const int  field_dim 
)

Register a tag with the manager that will be available for solution transfer.

Definition at line 242 of file DTK_STKMeshManager.hpp.

Teuchos::RCP< FunctionSpace > DataTransferKit::STKMeshManager::functionSpace ( ) const

Get the function space over which the mesh and its fields are defined.

Definition at line 99 of file DTK_STKMeshManager.cpp.

template<class FieldType >
Teuchos::RCP< FieldMultiVector > DataTransferKit::STKMeshManager::createFieldMultiVector ( const Teuchos::Ptr< FieldType > &  field,
const int  field_dim 
)

Given a field and dimension, build a vector over that field.

Definition at line 228 of file DTK_STKMeshManager.hpp.

Teuchos::RCP< EntitySet > DataTransferKit::STKMeshManager::entitySet ( ) const
overridevirtual

ClientManager interface implementation.

Get the entity set over which the fields are defined.

Implements DataTransferKit::ClientManager.

Definition at line 141 of file DTK_STKMeshManager.cpp.

Teuchos::RCP< EntityLocalMap > DataTransferKit::STKMeshManager::localMap ( ) const
overridevirtual

Get the local map for entities supporting the function.

Implements DataTransferKit::ClientManager.

Definition at line 148 of file DTK_STKMeshManager.cpp.

Teuchos::RCP< EntityShapeFunction > DataTransferKit::STKMeshManager::shapeFunction ( ) const
overridevirtual

Get the shape function for entities supporting the function.

Implements DataTransferKit::ClientManager.

Definition at line 155 of file DTK_STKMeshManager.cpp.

Teuchos::RCP< EntityIntegrationRule > DataTransferKit::STKMeshManager::integrationRule ( ) const
overridevirtual

Get the integration rule for entities supporting the function.

Implements DataTransferKit::ClientManager.

Definition at line 162 of file DTK_STKMeshManager.cpp.

PredicateFunction DataTransferKit::STKMeshManager::selectFunction ( ) const
overridevirtual

Get the selector function.

Implements DataTransferKit::ClientManager.

Definition at line 169 of file DTK_STKMeshManager.cpp.

Teuchos::RCP< Field > DataTransferKit::STKMeshManager::field ( const std::string &  field_name) const
overridevirtual

Get the field for the given string key.

Implements DataTransferKit::ClientManager.

Definition at line 176 of file DTK_STKMeshManager.cpp.


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