PRISMS-PF Manual v3.0-pre
Loading...
Searching...
No Matches
variableAttributes Struct Reference

Structure to hold the variable attributes that will be passed to a setInputParameters object. More...

#include <variableAttributes.h>

Public Member Functions

void format_dependencies ()
 Combine 'value' and 'gradient' residual dependencies to one dependency set per RHS, LHS, PP.
 
void parse_dependencies (std::map< uint, variableAttributes > &other_var_attributes)
 Take user-defined dependency sets to set the evaluation flags for each variable.
 
void parse_residual_dependencies ()
 Take user-defined dependency sets to set the residual flags for each variable.
 
std::set< EvalFlags * > eval_flags_for_eq_type (const variableAttributes &other_variable)
 Helper function that returns a set of pointers to the flags that need to be set when other_variable is dependent on this variable.
 

Public Attributes

std::string name
 
fieldType var_type = UNDEFINED_FIELD
 
PDEType eq_type = UNDEFINED_PDE
 
bool need_value_nucleation = false
 
bool nucleating_variable = false
 
bool is_pp = false
 
bool is_nonlinear = false
 
bool calc_integral = false
 
bool output_integral = false
 
std::set< std::string > dependencies_value_RHS
 
std::set< std::string > dependencies_gradient_RHS
 
std::set< std::string > dependencies_RHS
 
std::set< std::string > dependencies_value_LHS
 
std::set< std::string > dependencies_gradient_LHS
 
std::set< std::string > dependencies_LHS
 
std::set< std::string > dependencies_value_PP
 
std::set< std::string > dependencies_gradient_PP
 
std::set< std::string > dependencies_PP
 
std::set< std::string > dependency_set
 
EvalFlags eval_flags_explicit_RHS = dealii::EvaluationFlags::nothing
 
EvalFlags eval_flags_nonexplicit_RHS = dealii::EvaluationFlags::nothing
 
EvalFlags eval_flags_nonexplicit_LHS = dealii::EvaluationFlags::nothing
 
EvalFlags eval_flags_change_nonexplicit_LHS = dealii::EvaluationFlags::nothing
 
EvalFlags eval_flags_residual_explicit_RHS = dealii::EvaluationFlags::nothing
 
EvalFlags eval_flags_residual_nonexplicit_RHS = dealii::EvaluationFlags::nothing
 
EvalFlags eval_flags_residual_nonexplicit_LHS = dealii::EvaluationFlags::nothing
 
EvalFlags eval_flags_postprocess = dealii::EvaluationFlags::nothing
 
EvalFlags eval_flags_residual_postprocess = dealii::EvaluationFlags::nothing
 

Detailed Description

Structure to hold the variable attributes that will be passed to a setInputParameters object.

Member Function Documentation

◆ eval_flags_for_eq_type()

std::set< EvalFlags * > variableAttributes::eval_flags_for_eq_type ( const variableAttributes other_variable)

Helper function that returns a set of pointers to the flags that need to be set when other_variable is dependent on this variable.

Parameters
other_variableVariable that is dependent on this variable.

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