type_enums.h File Reference

#include <prismspf/config.h>
#include <cstdint>
#include <string>

Include dependency graph for type_enums.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Enumerations
enum	SolveType : std::uint8_t { Constant , Explicit , Linear , Newton }
	Type of PDE that is being solved. More...
enum	TensorRank : unsigned int { Undefined = static_cast<unsigned int>(-1) , Scalar = 0 , Vector = 1 }
	Tensor rank of the field. More...
enum	ElasticityModel : std::uint8_t { Isotropic , Transverse , Orthotropic , Anisotropic }
	Symmetry of elastic tensor. More...
enum	DependencyType : int {   DST = -2 , SRC = -1 , LHS = SRC , Solution = SRC ,   Trial = SRC , Change = SRC , Current = 0 , OldOne ,   OldTwo , OldThree , OldFour }
	Internal classification for types of variable dependencies. More...
enum	SolverToleranceType : std::uint8_t {   AbsoluteResidual , RMSEPerField , IntegratedPerField , RMSETotal ,   IntegratedTotal }
	Solver tolerance type. More...
enum	PreconditionerType : std::uint8_t { None , GMG }
	Preconditioner type. More...
enum	DataFormatType : std::uint8_t { VTKUnstructuredGrid , FlatBinary , LastEntry }
	Data formats for input initial conditions. LastEntry is used for loop bounds. More...

Functions
std::string	to_string (ElasticityModel type)
	Enum to string for ElasticityModel.
std::string	to_string (DependencyType type)
	Enum to string for DependencyType.
std::string	to_string (SolverToleranceType type)
	Enum to string for SolverToleranceType.
std::string	to_string (PreconditionerType type)
	Enum to string for PreconditionerType.
std::string	to_string (DataFormatType type)
	Enum to string for DataFormatType.

Enumeration Type Documentation

DataFormatType

enum DataFormatType : std::uint8_t

Data formats for input initial conditions. LastEntry is used for loop bounds.

Enumerator
VTKUnstructuredGrid
FlatBinary
LastEntry

DependencyType

enum DependencyType : int

Internal classification for types of variable dependencies.

Enumerator
DST
SRC
LHS
Solution
Trial
Change
Current
OldOne
OldTwo
OldThree
OldFour

ElasticityModel

enum ElasticityModel : std::uint8_t

Symmetry of elastic tensor.

Enumerator
Isotropic
Transverse
Orthotropic
Anisotropic

PreconditionerType

enum PreconditionerType : std::uint8_t

Preconditioner type.

Enumerator
None
GMG

SolverToleranceType

enum SolverToleranceType : std::uint8_t

Solver tolerance type.

Enumerator
AbsoluteResidual	Legacy.
RMSEPerField	The mean local error averaged over each field is lower than the tolerance.
IntegratedPerField	The integrated error averaged over each field is lower than the tolerance.
RMSETotal	The sum of the average local errors of each field is lower than the tolerance.
IntegratedTotal	The sum of the integrated errors of each field is lower than the tolerance.

SolveType

enum SolveType : std::uint8_t

Type of PDE that is being solved.

Enumerator
Constant	Fields remain constant in time. Be sure to set the solve_timing to Initialized.
Explicit	Each increment, variables are set to the evaluation of the submission in equations_rhs. This is often used for forward-Euler time integration and postprocessed fields.
Linear	Linear solver for implicit equations of the form Ax=b, solving for x, where A is a matrix of linear operators, and x1, x2, ..., xn are the fields being solved for. This is sometimes used for backward-Euler time integration. Evaluate Ax in equations_lhs using trial fields x. Evaluate b in equations_rhs.
Newton	Nonlinear solver for implicit equations of the form R(x)=0, solving for x, where R is a generic function of x1, x2, ..., xn. This is sometimes used for backward-Euler time integration. The solver performs Newton's method by iteravely solving for a change term Deltax using a linear solve of the form -[dR/dx](Deltax) = R(x) and then performing x -> x + damping * Deltax. See Newton's Method

TensorRank

enum TensorRank : unsigned int

Tensor rank of the field.

Currently, only scalar and vectors are supported.

Enumerator
Undefined
Scalar
Vector

Function Documentation

to_string() [1/5]

std::string to_string ( DataFormatType type )

inline

Enum to string for DataFormatType.

to_string() [2/5]

std::string to_string ( DependencyType type )

inline

Enum to string for DependencyType.

to_string() [3/5]

std::string to_string ( ElasticityModel type )

inline

Enum to string for ElasticityModel.

to_string() [4/5]

std::string to_string ( PreconditionerType type )

inline

Enum to string for PreconditionerType.

to_string() [5/5]

std::string to_string ( SolverToleranceType type )

inline

Enum to string for SolverToleranceType.