DICe::field_enums::Field_Spec Struct Reference

A struct that holds all the necessary information to define a field. More...

#include <DICe_FieldEnums.h>

Public Member Functions
	Field_Spec (const Field_Type field_type, const Field_Name label, const Entity_Rank rank, const Field_State field_state, const bool is_printable, const bool is_dof=false)
	Field_Spec ()
	Constructor with no arguments.
bool	operator== (const Field_Spec &right) const
bool	operator!= (const Field_Spec &right) const
bool	operator< (const Field_Spec &right) const
std::ostream &	print (std::ostream &os) const
Field_Type	get_field_type () const
	Return the field type.
Field_Name	get_name () const
	Return the field name.
Field_State	get_state () const
	Return the field state.
void	set_state (Field_State state)
	Set the field's state.
std::string	get_name_label () const
	Return the name of the field as a string.
Entity_Rank	get_rank () const
	Return the rank of the field.
bool	is_printable () const
	Returns true if the field is printable.
bool	is_dof () const
	Returns true if this field is a degree of freedom for a physics class.
bool	is_compatible (const Field_Spec &field_spec) const
bool	is_subrank_of (const field_enums::Entity_Rank parent_rank)
	Returns true if the field can be a subrank of the given rank (for example internal faces or edges)

Private Attributes
Field_Type	field_type_
	field type
Field_Name	name_
	field name
Entity_Rank	rank_
	field rank
Field_State	state_
	field state
bool	is_printable_
	True if this field can be printed or output to exodus file.
bool	is_dof_
	True if this field is a degree of freedom for a particular physics.

Detailed Description

A struct that holds all the necessary information to define a field.

Constructor & Destructor Documentation

Field_Spec()

DICe::field_enums::Field_Spec::Field_Spec	(	const Field_Type	field_type,
		const Field_Name	label,
		const Entity_Rank	rank,
		const Field_State	field_state,
		const bool	is_printable,
		const bool	is_dof = false
	)

Constructor

Parameters

field_type	The type of field
label	The name of the field
rank	The rank of the field
field_state	The state for this field
is_printable	True if this field can be output in the exodus mesh
is_dof	True if this field is a degree of freedon

Member Function Documentation

is_compatible()

bool DICe::field_enums::Field_Spec::is_compatible ( const Field_Spec &  field_spec ) const

inline

True if the two fields are compatible

Parameters

field_spec

The field_spec to compare to

operator!=()

bool DICe::field_enums::Field_Spec::operator!=

(

const Field_Spec &

right

)

const

Comparison operator

Parameters

right

The field spec to compare to

operator<()

bool DICe::field_enums::Field_Spec::operator< ( const Field_Spec &  right ) const

inline

Comparison operator

Parameters

right

The field spec to compare to

operator==()

bool DICe::field_enums::Field_Spec::operator==

(

const Field_Spec &

right

)

const

Comparison operator

Parameters

right

The field spec to compare to

print()

std::ostream& DICe::field_enums::Field_Spec::print

(

std::ostream &

os

)

const

Print the field to the given os

Parameters

os	The output stream