customAttributeLoader Class Reference

Inheritance diagram for customAttributeLoader:

Public Member Functions
void	loadVariableAttributes () override
	User-facing method where the variable attributes are set.
void	loadPostProcessorVariableAttributes () override
	User-facing method where the postprocessing variable attributes are set.
Public Member Functions inherited from variableAttributeLoader
	variableAttributeLoader ()=default
	Constructor.
virtual	~variableAttributeLoader ()=default
	Destructor.
void	init_variable_attributes ()
	Initialize the variable attributes from the two user-facing methods loadVariableAttributes() and loadPostProcessorVariableAttributes(). This must be called after the default constructor for derived classes.
AttributesList	get_var_attributes () const
	getter function for variable attributes list (copy).
AttributesList	get_pp_attributes () const
	getter function for postprocessing attributes list (copy).

Additional Inherited Members
Protected Member Functions inherited from variableAttributeLoader
void	set_variable_name (const unsigned int &index, const std::string &name) const
	Set the name of the variable at index to name.
void	set_variable_type (const unsigned int &index, const fieldType &var_type) const
	Set the field type of the variable at index to var_type where var_type can be SCALAR or VECTOR.
void	set_variable_equation_type (const unsigned int &index, const PDEType &var_eq_type) const
	Set the PDE type of the variable at index to var_eq_type where var_eq_typecan be EXPLICIT_TIME_DEPENDENT, IMPLICIT_TIME_DEPENDENT, TIME_INDEPENDENT, AUXILIARY.
void	set_dependencies_value_term_RHS (const unsigned int &index, const std::string &dependencies)
	Add dependencies for the value term of the RHS equation of the variable at index.
void	set_dependencies_gradient_term_RHS (const unsigned int &index, const std::string &dependencies)
	Add dependencies for the gradient term of the RHS equation of the variable at index.
void	set_dependencies_value_term_LHS (const unsigned int &index, const std::string &dependencies) const
	Add dependencies for the value term of the LHS equation of the variable at index.
void	set_dependencies_gradient_term_LHS (const unsigned int &index, const std::string &dependencies) const
	Add dependencies for the gradient term of the LHS equation of the variable at index.
template<typename Iterable >
void	insert_dependencies_value_term_RHS (const unsigned int &index, const Iterable &dependencies)
	Insert dependencies for the value term of the RHS equation of the variable at index.
template<typename Iterable >
void	insert_dependencies_gradient_term_RHS (const unsigned int &index, const Iterable &dependencies)
	Insert dependencies for the gradient term of the RHS equation of the variable at index.
template<typename Iterable >
void	insert_dependencies_value_term_LHS (const unsigned int &index, const Iterable &dependencies) const
	Insert dependencies for the value term of the LHS equation of the variable at index.
template<typename Iterable >
void	insert_dependencies_gradient_term_LHS (const unsigned int &index, const Iterable &dependencies) const
	Insert dependencies for the gradient term of the LHS equation of the variable at index.
void	set_need_value_nucleation (const unsigned int &index, const bool &flag) const
	Flag whether the variable at index is needed to calculate the nucleation probability.
void	set_allowed_to_nucleate (const unsigned int &index, const bool &flag) const
	Flag whether the variable at index is can have a nucleation event.
void	set_output_integral (const unsigned int &index, const bool &flag) const
	(Postprocess only) Flag whether the postprocessing variable at index should have its domain integral calculated and output.

Member Function Documentation

loadPostProcessorVariableAttributes()

void customAttributeLoader::loadPostProcessorVariableAttributes ( )

overridevirtual

User-facing method where the postprocessing variable attributes are set.

Reimplemented from variableAttributeLoader.

loadVariableAttributes()

void customAttributeLoader::loadVariableAttributes ( )

overridevirtual

User-facing method where the variable attributes are set.

Reimplemented from variableAttributeLoader.

---

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

• /home/runner/work/phaseField/phaseField/include/core/variableAttributeLoader.h