ABLATE Source Documentation  0.12.34
ablate::eos::StiffenedGas Class Reference
+ Inheritance diagram for ablate::eos::StiffenedGas:

Public Member Functions

 StiffenedGas (std::shared_ptr< ablate::parameters::Parameters >, std::vector< std::string > species={})
 
void View (std::ostream &stream) const override
 
PetscReal GetSpecificHeatRatio () const
 
PetscReal GetSpecificHeatCp () const
 
PetscReal GetReferencePressure () const
 
ThermodynamicFunction GetThermodynamicFunction (ThermodynamicProperty property, const std::vector< domain::Field > &fields) const override
 
ThermodynamicTemperatureFunction GetThermodynamicTemperatureFunction (ThermodynamicProperty property, const std::vector< domain::Field > &fields) const override
 
EOSFunction GetFieldFunctionFunction (const std::string &field, ThermodynamicProperty property1, ThermodynamicProperty property2, std::vector< std::string > otherProperties) const override
 
const std::vector< std::string > & GetSpeciesVariables () const override
 
virtual const std::vector< std::string > & GetProgressVariables () const override
 
- Public Member Functions inherited from ablate::eos::EOS
 EOS (std::string typeIn)
 
virtual std::vector< std::string > GetFieldTags () const
 
virtual std::vector< std::shared_ptr< domain::FieldDescriptor > > GetAdditionalFields () const
 
virtual const std::vector< std::string > & GetFieldFunctionProperties () const
 

Additional Inherited Members

- Static Public Attributes inherited from ablate::eos::EOS
static const std::string YI = "Yi"
 
static const std::string PROGRESS = "Progress"
 
- Protected Attributes inherited from ablate::eos::EOS
const std::string type
 

Member Function Documentation

◆ GetFieldFunctionFunction()

ablate::eos::EOSFunction ablate::eos::StiffenedGas::GetFieldFunctionFunction ( const std::string &  field,
ThermodynamicProperty  property1,
ThermodynamicProperty  property2,
std::vector< std::string >  otherProperties 
) const
overridevirtual

Single function to produce fieldFunction function for any two properties, velocity, and species mass fractions. These calls can be slower and should be used for init/output only

Parameters
field
property1
property2

Implements ablate::eos::EOS.

◆ GetProgressVariables()

virtual const std::vector<std::string>& ablate::eos::StiffenedGas::GetProgressVariables ( ) const
inlineoverridevirtual

Returns a vector of all extra variables required to utilize the equation of state

Returns

Implements ablate::eos::EOS.

◆ GetReferencePressure()

PetscReal ablate::eos::StiffenedGas::GetReferencePressure ( ) const
inline

Get reference pressure a stiffened gas

Returns

◆ GetSpeciesVariables()

const std::vector<std::string>& ablate::eos::StiffenedGas::GetSpeciesVariables ( ) const
inlineoverridevirtual

returns the species supported by this EOS

Returns

Implements ablate::eos::EOS.

◆ GetSpecificHeatCp()

PetscReal ablate::eos::StiffenedGas::GetSpecificHeatCp ( ) const
inline

Get constant specific at constant pressure (Cp) ratio for a stiffened gas.

Returns

◆ GetSpecificHeatRatio()

PetscReal ablate::eos::StiffenedGas::GetSpecificHeatRatio ( ) const
inline

Get constant specific heat ratio for a stiffened gas.

Returns

◆ GetThermodynamicFunction()

ablate::eos::ThermodynamicFunction ablate::eos::StiffenedGas::GetThermodynamicFunction ( ThermodynamicProperty  property,
const std::vector< domain::Field > &  fields 
) const
overridevirtual

Single function to produce thermodynamic function for any property based upon the available fields

Parameters
property
fields
Returns

Implements ablate::eos::EOS.

◆ GetThermodynamicTemperatureFunction()

ablate::eos::ThermodynamicTemperatureFunction ablate::eos::StiffenedGas::GetThermodynamicTemperatureFunction ( ThermodynamicProperty  property,
const std::vector< domain::Field > &  fields 
) const
overridevirtual

Single function to produce thermodynamic function for any property based upon the available fields and temperature

Parameters
property
fields
Returns

Implements ablate::eos::EOS.

◆ View()

void ablate::eos::StiffenedGas::View ( std::ostream &  stream) const
overridevirtual

Print the details of this eos

Parameters
stream

Implements ablate::eos::EOS.


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