ASPECT
Public Types | Static Public Member Functions | Public Attributes | Static Public Attributes | List of all members
aspect::CompositionalFieldDescription Struct Reference

Public Types

enum  Type {
  chemical_composition = 0, stress = 1, strain = 2, grain_size = 3,
  porosity = 4, density = 5, entropy = 6, reaction_progress = 7,
  generic = 8, unspecified = 9
}
 

Static Public Member Functions

static Type parse_type (const std::string &input)
 
static std::string type_to_string (const Type type)
 

Public Attributes

enum aspect::CompositionalFieldDescription::Type type
 

Static Public Attributes

static constexpr unsigned int n_types = 9
 

Detailed Description

A data structure containing a description of each compositional field. At present, this structure only includes the field type (i.e., whether it is of type chemical composition, porosity, etc.).

Definition at line 52 of file introspection.h.

Member Enumeration Documentation

§ Type

This enum lists available compositional field types.

Enumerator
chemical_composition 
stress 
strain 
grain_size 
porosity 
density 
entropy 
reaction_progress 
generic 
unspecified 

Definition at line 57 of file introspection.h.

Member Function Documentation

§ parse_type()

static Type aspect::CompositionalFieldDescription::parse_type ( const std::string &  input)
inlinestatic

This function translates an input string into the available enum options for the type of compositional field.

Definition at line 82 of file introspection.h.

References AssertThrow, chemical_composition, density, entropy, StandardExceptions::ExcMessage(), generic, grain_size, porosity, reaction_progress, strain, stress, and unspecified.

§ type_to_string()

static std::string aspect::CompositionalFieldDescription::type_to_string ( const Type  type)
inlinestatic

This function translates a compositional field type into the string used in the input file and diagnostic output.

Definition at line 116 of file introspection.h.

References AssertThrow, chemical_composition, density, entropy, StandardExceptions::ExcInternalError(), grain_size, porosity, strain, stress, and unspecified.

Member Data Documentation

§ type

enum aspect::CompositionalFieldDescription::Type aspect::CompositionalFieldDescription::type

§ n_types

constexpr unsigned int aspect::CompositionalFieldDescription::n_types = 9
static

The number of different types defined in Type.

Definition at line 74 of file introspection.h.


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