Class to manage the variable attributes that the user specifies. More...

#include <variable_attribute_loader.h>

Inheritance diagram for variableAttributeLoader:

Public Member Functions
	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).

Protected Member Functions
virtual void	loadVariableAttributes ()
	User-facing method where the variable attributes are set for solution fields and postprocess fields.

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_type`can 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`.

Detailed Description

Class to manage the variable attributes that the user specifies.

Member Function Documentation

◆ insert_dependencies_gradient_term_LHS()

template<typename Iterable >

void variableAttributeLoader::insert_dependencies_gradient_term_LHS	(	const unsigned int &	index,
		const Iterable &	dependencies
	)

protected

Insert dependencies for the gradient term of the LHS equation of the variable at index.

Parameters

index	Index of variable
dependencies	Container containing list of dependency strings for variable at `index` Hint: {"variable", "grad(variable)", "hess(variable)"}

◆ insert_dependencies_gradient_term_RHS()

template<typename Iterable >

void variableAttributeLoader::insert_dependencies_gradient_term_RHS	(	const unsigned int &	index,
		const Iterable &	dependencies
	)

protected

Insert dependencies for the gradient term of the RHS equation of the variable at index.

Parameters

index	Index of variable
dependencies	Container containing list of dependency strings for variable at `index` Hint: {"variable", "grad(variable)", "hess(variable)"}

◆ insert_dependencies_value_term_LHS()

template<typename Iterable >

void variableAttributeLoader::insert_dependencies_value_term_LHS	(	const unsigned int &	index,
		const Iterable &	dependencies
	)

protected

Insert dependencies for the value term of the LHS equation of the variable at index.

Parameters

index	Index of variable
dependencies	Container containing list of dependency strings for variable at `index` Hint: {"variable", "grad(variable)", "hess(variable)"}

◆ insert_dependencies_value_term_RHS()

template<typename Iterable >

void variableAttributeLoader::insert_dependencies_value_term_RHS	(	const unsigned int &	index,
		const Iterable &	dependencies
	)

protected

Insert dependencies for the value term of the RHS equation of the variable at index.

Parameters

index	Index of variable
dependencies	Container containing list of dependency strings for variable at `index` Hint: {"variable", "grad(variable)", "hess(variable)"}

◆ loadVariableAttributes()

PRISMS_PF_BEGIN_NAMESPACE void variableAttributeLoader::loadVariableAttributes ( )

protectedvirtual

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

Reimplemented in customAttributeLoader.

◆ set_dependencies_gradient_term_LHS()

void variableAttributeLoader::set_dependencies_gradient_term_LHS	(	const unsigned int &	index,
		const std::string &	dependencies
	)

protected

Add dependencies for the gradient term of the LHS equation of the variable at index.

Parameters

index	Index of variable
dependencies	String containing comma-separated list of dependencies for variable at `index` Hint: "variable, grad(variable), hess(variable)"

◆ set_dependencies_gradient_term_RHS()

void variableAttributeLoader::set_dependencies_gradient_term_RHS	(	const unsigned int &	index,
		const std::string &	dependencies
	)

protected

Add dependencies for the gradient term of the RHS equation of the variable at index.

Parameters

index	Index of variable
dependencies	String containing comma-separated list of dependencies for variable at `index` Hint: "variable, grad(variable), hess(variable)"

◆ set_dependencies_value_term_LHS()

void variableAttributeLoader::set_dependencies_value_term_LHS	(	const unsigned int &	index,
		const std::string &	dependencies
	)

protected

Add dependencies for the value term of the LHS equation of the variable at index.

Parameters

index	Index of variable
dependencies	String containing comma-separated list of dependencies for variable at `index` Hint: "variable, grad(variable), hess(variable)"

◆ set_dependencies_value_term_RHS()

void variableAttributeLoader::set_dependencies_value_term_RHS	(	const unsigned int &	index,
		const std::string &	dependencies
	)

protected

Add dependencies for the value term of the RHS equation of the variable at index.

Parameters

index	Index of variable
dependencies	String containing comma-separated list of dependencies for variable at `index` Hint: "variable, grad(variable), hess(variable)"

◆ set_is_postprocessed_field()

void variableAttributeLoader::set_is_postprocessed_field	(	const unsigned int &	index,
		const bool &	is_postprocess
	)

protected

Set the whether the field is a postprocessed field.

Parameters

index	Index of variable
is_postprocess	Whether the field is postprocessed.

◆ set_variable_equation_type()

void variableAttributeLoader::set_variable_equation_type	(	const unsigned int &	index,
		const PDEType &	pde_type
	)

protected

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.

Parameters

index	Index of variable
pde_type	PDE type of variable at `index`.

◆ set_variable_name()

void variableAttributeLoader::set_variable_name	(	const unsigned int &	index,
		const std::string &	name
	)

protected

Set the name of the variable at index to name.

Parameters

index	Index of variable
name	Name of variable at `index`

◆ set_variable_type()

void variableAttributeLoader::set_variable_type	(	const unsigned int &	index,
		const fieldType &	field_type
	)

protected

Set the field type of the variable at index to field_type where field_type can be SCALAR or VECTOR.

Parameters

index	Index of variable
field_type	Field type of variable at `index` (`SCALAR` or `VECTOR`).

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

/home/runner/work/phaseField/phaseField/include/prismspf/core/variable_attribute_loader.h
/home/runner/work/phaseField/phaseField/src/core/variable_attribute_loader.cc

Public Member Functions

Protected Member Functions

Detailed Description

Member Function Documentation

◆ insert_dependencies_gradient_term_LHS()

◆ insert_dependencies_gradient_term_RHS()

◆ insert_dependencies_value_term_LHS()

◆ insert_dependencies_value_term_RHS()

◆ loadVariableAttributes()

◆ set_dependencies_gradient_term_LHS()

◆ set_dependencies_gradient_term_RHS()

◆ set_dependencies_value_term_LHS()

◆ set_dependencies_value_term_RHS()

◆ set_is_postprocessed_field()

◆ set_variable_equation_type()

◆ set_variable_name()

◆ set_variable_type()