ABLATE Source Documentation  0.12.34
ablate::finiteVolume::CompressibleFlowFields Class Reference
+ Inheritance diagram for ablate::finiteVolume::CompressibleFlowFields:

Public Types

enum  EulerComponents {
  RHO , RHOE , RHOU , RHOV ,
  RHOW
}
 
enum class  ValidRange { POSITIVE , FULL , BOUND , MINUSONETOONE }
 store extra variable founds
 

Public Member Functions

 CompressibleFlowFields (std::shared_ptr< eos::EOS > eos, std::shared_ptr< domain::Region > region={}, std::shared_ptr< parameters::Parameters > conservedFieldParameters={})
 
std::vector< std::shared_ptr< domain::FieldDescription > > GetFields () override
 

Static Public Attributes

static const std::string EULER_FIELD = "euler"
 the primary euler field containing the EulerComponents
 
static const std::string CONSERVED = "density"
 The conserved prefix used for fields that have a conserved and non conserved form.
 
static const std::string YI_FIELD = eos::EOS::YI
 the conserved (density*yi) solution field for species mass fractions
 
static const std::string DENSITY_YI_FIELD = CONSERVED + YI_FIELD
 
static const std::string PROGRESS_FIELD = eos::EOS::PROGRESS
 progress fields are used by the eos/chemistry model to transport required non species
 
static const std::string DENSITY_PROGRESS_FIELD = CONSERVED + PROGRESS_FIELD
 
static const std::string EV_TAG = "EV"
 the conserved tag used to tag all fields that should act like extra variables (transported with the flow)
 
static const std::string PositiveRange = "positive"
 
static const std::string FullRange = "full"
 
static const std::string BoundRange = "bound"
 
static const std::string MinusOneToOneRange = "minusOneToOneRange"
 
static const std::string EV_FIELD = "EV"
 these are arbitrary ev fields
 
static const std::string DENSITY_EV_FIELD = CONSERVED + EV_FIELD
 
static const std::string TEMPERATURE_FIELD = "temperature"
 some common aux fields
 
static const std::string VELOCITY_FIELD = "velocity"
 
static const std::string PRESSURE_FIELD = "pressure"
 

Protected Attributes

const std::shared_ptr< eos::EOSeos
 
const std::shared_ptr< domain::Regionregion
 
const std::shared_ptr< parameters::ParametersconservedFieldOptions
 
const std::shared_ptr< parameters::ParametersauxFieldOptions = ablate::parameters::MapParameters::Create({{"petscfv_type", "leastsquares"}, {"petsclimiter_type", "none"}})
 

Constructor & Destructor Documentation

◆ CompressibleFlowFields()

ablate::finiteVolume::CompressibleFlowFields::CompressibleFlowFields ( std::shared_ptr< eos::EOS eos,
std::shared_ptr< domain::Region region = {},
std::shared_ptr< parameters::Parameters conservedFieldParameters = {} 
)
explicit

Create a helper class that produces the required compressible flow fields based upon the eos and specifed region

Parameters
eosthe eos used to determine the species
regionthe region for all of the fields
conservedFieldParametersoverride the default field parameters for the conserved field

Member Function Documentation

◆ GetFields()

std::vector< std::shared_ptr< ablate::domain::FieldDescription > > ablate::finiteVolume::CompressibleFlowFields::GetFields ( )
overridevirtual

override and return the compressible flow fields

Returns

Implements ablate::domain::FieldDescriptor.


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