FieldAttributes Struct Reference

Structure to hold the attributes of a field. This includes things like the name, rank, and nucleation information.. More...

#include <field_attributes.h>

Public Member Functions
	FieldAttributes (std::string _name="", TensorRank _field_type=TensorRank::Scalar, bool _is_nucleation_rate_variable=false, std::vector< Types::Index > _nucleating_field_indices=std::vector< Types::Index >())
	Constructor.

Public Attributes
std::string	name
	Field name.
TensorRank	field_type = TensorRank::Scalar
	Field type (Scalar/Vector).
bool	is_nucleation_rate_variable = false
	Is a nucleation rate.
std::vector< Types::Index >	nucleating_field_indices
	If this is a nucleation rate, the indices of the nucleating fields.

Detailed Description

Structure to hold the attributes of a field. This includes things like the name, rank, and nucleation information..

Constructor & Destructor Documentation

FieldAttributes()

FieldAttributes::FieldAttributes ( std::string  _name = "", TensorRank  _field_type = TensorRank::Scalar, bool  _is_nucleation_rate_variable = false, std::vector< Types::Index >  _nucleating_field_indices = std::vector<Types::Index>()  )

inlineexplicit

Constructor.

Member Data Documentation

field_type

TensorRank FieldAttributes::field_type = TensorRank::Scalar

Field type (Scalar/Vector).

is_nucleation_rate_variable

bool FieldAttributes::is_nucleation_rate_variable = false

Is a nucleation rate.

name

std::string FieldAttributes::name

Field name.

nucleating_field_indices

std::vector<Types::Index> FieldAttributes::nucleating_field_indices

If this is a nucleation rate, the indices of the nucleating fields.

---

The documentation for this struct was generated from the following file:

• /home/runner/work/phaseField/phaseField/include/prismspf/core/field_attributes.h