ABLATE Source Documentation  0.12.33
Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
ablate::domain::Field Struct Reference

Public Member Functions

Field CreateSubField (PetscInt subId, PetscInt offset) const
 
bool Tagged (std::string_view tag) const
 
Field Rename (std::string newName) const
 
std::size_t ComponentIndex (std::string_view search) const
 
std::size_t ComponentOffset (std::string_view search) const
 

Static Public Member Functions

static Field FromFieldDescription (const FieldDescription &fieldDescription, PetscInt id, PetscInt subId=PETSC_DEFAULT, PetscInt offset=PETSC_DEFAULT)
 

Public Attributes

const std::string name
 
const PetscInt numberComponents
 
const std::vector< std::string > components
 
const PetscInt id
 
const PetscInt subId = PETSC_DEFAULT
 
const PetscInt offset = PETSC_DEFAULT
 
enum FieldLocation location = FieldLocation::SOL
 
enum FieldType type
 
const std::set< std::string > tags
 

Member Function Documentation

◆ ComponentIndex()

std::size_t ablate::domain::Field::ComponentIndex ( std::string_view  search) const
inline

return the component index in the current field

Parameters
search
Returns

◆ ComponentOffset()

std::size_t ablate::domain::Field::ComponentOffset ( std::string_view  search) const
inline

return the component offset (field offset + index) in the current field/component

Parameters
search
Returns

◆ Rename()

ablate::domain::Field ablate::domain::Field::Rename ( std::string  newName) const

Create a copy and rename the field

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