ABLATE Source Documentation  0.12.34
ablate::particles::FieldDescription Struct Reference

Public Member Functions

 FieldDescription (std::string name, domain::FieldLocation type, const std::vector< std::string > &components={}, PetscDataType dataType=PETSC_DATATYPE_UNKNOWN)
 

Public Attributes

const std::string name
 The unique name of the particle field.
 
const std::vector< std::string > components = {"_"}
 Optional name of the components. This is used to determine the number of components.
 
enum domain::FieldLocation location = domain::FieldLocation::AUX
 The type of field, (solution or aux)
 
const PetscDataType dataType = PETSC_REAL
 The data type, default is double.
 

Constructor & Destructor Documentation

◆ FieldDescription()

ablate::particles::FieldDescription::FieldDescription ( std::string  name,
domain::FieldLocation  type,
const std::vector< std::string > &  components = {},
PetscDataType  dataType = PETSC_DATATYPE_UNKNOWN 
)

default constructor

Parameters
namename of the field
typeAUX or SOL type
componentsthe name of each components, if empty it it is assumed to be one component
dataTypethe type of data, default is real

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