PRISMS-PF Manual
Loading...
Searching...
No Matches
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

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

Enumerator
VTKUnstructuredGrid 
FlatBinary 
LastEntry 

◆ DependencyType

Internal classification for types of variable dependencies.

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

◆ ElasticityModel

Symmetry of elastic tensor.

Enumerator
Isotropic 
Transverse 
Orthotropic 
Anisotropic 

◆ PreconditionerType

Preconditioner type.

Enumerator
None 
GMG 

◆ SolverToleranceType

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

Type of PDE that is being solved.

Enumerator
Constant 
Explicit 
Linear 
Newton 

◆ TensorRank

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.