Mundy: Multibody Nonlocal Dynamics Version of the Day
Loading...
Searching...
No Matches
mundy::mesh::FieldDeclaration Class Reference

#include <DeclareField.hpp>

Constructors and Assignment Operators

using invalid_field_value_typeype = void
 FieldDeclaration (stk::mesh::MetaData &meta_data)
 Canonical constructor.
 FieldDeclaration (const FieldDeclaration &)=default
 Copy/Move constructors and assignment operators.
 FieldDeclaration (FieldDeclaration &&)=default
FieldDeclarationoperator= (const FieldDeclaration &)=default
FieldDeclarationoperator= (FieldDeclaration &&)=default

Fluent interface

template<typename T>
FieldDeclarationT< T > type ()
 Set the type of the field (must be called before declare()).
FieldDeclaration rank (stk::mesh::EntityRank rank)
 Set the entity rank of the field (must be called before declare()).
FieldDeclaration name (const std::string &field_name)
 Set the name of the field (must be called before declare()).
FieldDeclaration role (Ioss::Field::RoleType field_role)
 Set the io role of the field (optional).
FieldDeclaration output_type (stk::io::FieldOutputType output_type)
 Set the stk output type of the field (optional).
stk::mesh::MetaDatameta_data () const
bool has_rank () const
bool has_name () const
bool has_role () const
bool has_output_type () const
stk::mesh::EntityRank rank_value () const
const std::string & name_value () const
Ioss::Field::RoleType role_value () const
stk::io::FieldOutputType output_type_value () const

Member Typedef Documentation

◆ invalid_field_value_typeype

Constructor & Destructor Documentation

◆ FieldDeclaration() [1/3]

mundy::mesh::FieldDeclaration::FieldDeclaration ( stk::mesh::MetaData & meta_data)
inline

◆ FieldDeclaration() [2/3]

mundy::mesh::FieldDeclaration::FieldDeclaration ( const FieldDeclaration & )
default

◆ FieldDeclaration() [3/3]

mundy::mesh::FieldDeclaration::FieldDeclaration ( FieldDeclaration && )
default

Member Function Documentation

◆ operator=() [1/2]

FieldDeclaration & mundy::mesh::FieldDeclaration::operator= ( const FieldDeclaration & )
default

◆ operator=() [2/2]

FieldDeclaration & mundy::mesh::FieldDeclaration::operator= ( FieldDeclaration && )
default

◆ type()

template<typename T>
FieldDeclarationT< T > mundy::mesh::FieldDeclaration::type ( )
inline

◆ rank()

FieldDeclaration mundy::mesh::FieldDeclaration::rank ( stk::mesh::EntityRank rank)
inline

◆ name()

FieldDeclaration mundy::mesh::FieldDeclaration::name ( const std::string & field_name)
inline

◆ role()

FieldDeclaration mundy::mesh::FieldDeclaration::role ( Ioss::Field::RoleType field_role)
inline

◆ output_type()

FieldDeclaration mundy::mesh::FieldDeclaration::output_type ( stk::io::FieldOutputType output_type)
inline

◆ meta_data()

stk::mesh::MetaData & mundy::mesh::FieldDeclaration::meta_data ( ) const
inline

◆ has_rank()

bool mundy::mesh::FieldDeclaration::has_rank ( ) const
inline

◆ has_name()

bool mundy::mesh::FieldDeclaration::has_name ( ) const
inline

◆ has_role()

bool mundy::mesh::FieldDeclaration::has_role ( ) const
inline

◆ has_output_type()

bool mundy::mesh::FieldDeclaration::has_output_type ( ) const
inline

◆ rank_value()

stk::mesh::EntityRank mundy::mesh::FieldDeclaration::rank_value ( ) const
inline

◆ name_value()

const std::string & mundy::mesh::FieldDeclaration::name_value ( ) const
inline

◆ role_value()

Ioss::Field::RoleType mundy::mesh::FieldDeclaration::role_value ( ) const
inline

◆ output_type_value()

stk::io::FieldOutputType mundy::mesh::FieldDeclaration::output_type_value ( ) const
inline