Inheritance diagram for ablate::eos::TChemBase:

Classes
struct	FunctionContext

Public Member Functions
	TChemBase (const std::string &eosName, std::filesystem::path mechanismFile, const std::shared_ptr< ablate::monitors::logs::Log > &={}, const std::shared_ptr< ablate::parameters::Parameters > &options={})

void	View (std::ostream &stream) const override

tChemLib::KineticModelData &	GetKineticModelData ()

real_type_1d_view	GetEnthalpyOfFormation ()

const std::vector< std::string > &	GetSpeciesVariables () const override

virtual const std::vector< std::string > &	GetProgressVariables () const override

double	GetEnthalpyOfFormation (std::string_view speciesName) const override

Public Member Functions inherited from ablate::eos::ChemistryModel
	ChemistryModel (std::string name)

virtual std::shared_ptr< SourceCalculator >	CreateSourceCalculator (const std::vector< domain::Field > &fields, const ablate::domain::Range &cellRange)=0

virtual std::vector< std::tuple< ablate::solver::CellSolver::SolutionFieldUpdateFunction, void *, std::vector< std::string > > >	GetSolutionFieldUpdates ()

virtual std::map< std::string, double >	GetSpeciesMolecularMass () const

virtual std::map< std::string, double >	GetElementInformation () const

virtual std::map< std::string, std::map< std::string, int > >	GetSpeciesElementalInformation () const

virtual ThermodynamicTemperatureMassFractionFunction	GetThermodynamicTemperatureMassFractionFunction (ThermodynamicProperty property, const std::vector< domain::Field > &fields) const

Public Member Functions inherited from ablate::eos::EOS
	EOS (std::string typeIn)

virtual ThermodynamicFunction	GetThermodynamicFunction (ThermodynamicProperty property, const std::vector< domain::Field > &fields) const =0

virtual ThermodynamicTemperatureFunction	GetThermodynamicTemperatureFunction (ThermodynamicProperty property, const std::vector< domain::Field > &fields) const =0

virtual EOSFunction	GetFieldFunctionFunction (const std::string &field, ThermodynamicProperty property1, ThermodynamicProperty property2, std::vector< std::string > otherProperties) const =0

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

Static Public Attributes
static const double	TREF = 298.15

Static Public Attributes inherited from ablate::eos::EOS
static const std::string	YI = "Yi"

static const std::string	PROGRESS = "Progress"

Protected Attributes
tChem::SourceCalculator::ChemistryConstraints	constraints
	hold a copy of the constrains that can be used for single or batch source calculation

const std::filesystem::path	mechanismFile
	the mechanismFile may be chemkin or yaml based

std::shared_ptr< ablate::monitors::logs::Log >	log
	an optional log file for tchem echo redirection

tChemLib::KineticModelData	kineticsModel

std::shared_ptr< tChemLib::KineticModelGasConstData< typename Tines::UseThisDevice< host_exec_space >::type > >	kineticsModelDataHost

std::shared_ptr< tChemLib::KineticModelGasConstData< typename Tines::UseThisDevice< exec_space >::type > >	kineticsModelDataDevice

std::vector< std::string >	species

real_type_1d_view	enthalpyReferenceDevice

real_type_1d_view_host	enthalpyReferenceHost

Protected Attributes inherited from ablate::eos::EOS
const std::string	type

Static Protected Attributes
static const std::array< std::string, 2 >	validFileExtensions = {".yaml", ".yml"}

Constructor & Destructor Documentation

◆ TChemBase()

ablate::eos::TChemBase::TChemBase	(	const std::string &	eosName,
		std::filesystem::path	mechanismFile,
		const std::shared_ptr< ablate::monitors::logs::Log > &	logIn = `{}`,
		const std::shared_ptr< ablate::parameters::Parameters > &	options = `{}`
	)

explicit

The tChem EOS can utilize either a mechanical & thermo file using the Chemkin file format for a modern yaml file.

Parameters

mechFile
optionalThermoFile

Member Function Documentation

◆ GetEnthalpyOfFormation() [1/2]

real_type_1d_view ablate::eos::TChemBase::GetEnthalpyOfFormation ( )

inline

Get the reference enthalpy per species

◆ GetEnthalpyOfFormation() [2/2]

double ablate::eos::TChemBase::GetEnthalpyOfFormation ( std::string_view speciesName ) const

inlineoverridevirtual

Helper function to get the specific EnthalpyOfFormation

Parameters

species

Returns

Reimplemented from ablate::eos::ChemistryModel.

◆ GetKineticModelData()

tChemLib::KineticModelData& ablate::eos::TChemBase::GetKineticModelData ( )

inline

return reference to kinetic data for other users

◆ GetProgressVariables()

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

inlineoverridevirtual

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

Returns

Implements ablate::eos::EOS.

Reimplemented in ablate::eos::TChemSoot.

◆ GetSpeciesVariables()

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

inlineoverridevirtual

Species supported by this EOS species model functions

Returns

Implements ablate::eos::EOS.

◆ View()

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

overridevirtual

Print the details of this eos

Parameters

stream

Implements ablate::eos::EOS.

Reimplemented in ablate::eos::TChemSoot.

Member Data Documentation

◆ enthalpyReferenceDevice

real_type_1d_view ablate::eos::TChemBase::enthalpyReferenceDevice

protected

The reference enthalpy per species

◆ enthalpyReferenceHost

real_type_1d_view_host ablate::eos::TChemBase::enthalpyReferenceHost

protected

The reference enthalpy per species

◆ kineticsModel

tChemLib::KineticModelData ablate::eos::TChemBase::kineticsModel

protected

The kinetic model data

◆ kineticsModelDataDevice

std::shared_ptr<tChemLib::KineticModelGasConstData<typename Tines::UseThisDevice<exec_space>::type> > ablate::eos::TChemBase::kineticsModelDataDevice

protected

Store the primary kinetics data on the device

◆ kineticsModelDataHost

std::shared_ptr<tChemLib::KineticModelGasConstData<typename Tines::UseThisDevice<host_exec_space>::type> > ablate::eos::TChemBase::kineticsModelDataHost

protected

Store the primary kinetics data on the device

◆ species

std::vector<std::string> ablate::eos::TChemBase::species

protected

keep the species names as

◆ validFileExtensions

const std::array<std::string, 2> ablate::eos::TChemBase::validFileExtensions = {".yaml", ".yml"}

inlinestaticprotected

only allow modern input files

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

src/eos/tChemBase.hpp
src/eos/tChemBase.cpp

Classes

Public Member Functions

Static Public Attributes

Protected Attributes

Static Protected Attributes

Constructor & Destructor Documentation

◆ TChemBase()

Member Function Documentation

◆ GetEnthalpyOfFormation() [1/2]

◆ GetEnthalpyOfFormation() [2/2]

◆ GetKineticModelData()

◆ GetProgressVariables()

◆ GetSpeciesVariables()

◆ View()

Member Data Documentation

◆ enthalpyReferenceDevice

◆ enthalpyReferenceHost

◆ kineticsModel

◆ kineticsModelDataDevice

◆ kineticsModelDataHost

◆ species

◆ validFileExtensions