customAttributeLoader Class Reference

Inheritance diagram for customAttributeLoader:

Public Member Functions
void	loadVariableAttributes () override
	User-facing method where the variable attributes are set for solution fields and postprocess fields.
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.
std::map< unsigned int, variableAttributes >	get_var_attributes () const
	getter function for variable attributes list (copy).

Additional Inherited Members
Protected Member Functions inherited from variableAttributeLoader
void	set_variable_name (const unsigned int &index, const std::string &name)
	Set the name of the variable at index to name.
void	set_variable_type (const unsigned int &index, const fieldType &field_type)
	Set the field type of the variable at index to field_type where field_type can be SCALAR or VECTOR.
void	set_variable_equation_type (const unsigned int &index, const PDEType &pde_type)
	Set the PDE type of the variable at index to pde_type where pde_typecan be EXPLICIT_TIME_DEPENDENT, IMPLICIT_TIME_DEPENDENT, TIME_INDEPENDENT, AUXILIARY.
void	set_is_postprocessed_field (const unsigned int &index, const bool &is_postprocess)
	Set the whether the field is a postprocessed field.
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)
	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)
	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)
	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)
	Insert dependencies for the gradient term of the LHS equation of the variable at index.

Member Function Documentation

loadVariableAttributes()

void customAttributeLoader::loadVariableAttributes ( )

overridevirtual

User-facing method where the variable attributes are set for solution fields and postprocess fields.

Reimplemented from variableAttributeLoader.

---

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

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