Wrapper class for storing state for constant transport properties, including Antioch::ConstantLewisDiffusivity. More...

#include <antioch_constant_transport_mixture.h>

Inheritance diagram for GRINS::AntiochConstantTransportMixture< Conductivity >:

Collaboration diagram for GRINS::AntiochConstantTransportMixture< Conductivity >:

Public Types
typedef AntiochChemistry	ChemistryParent

Public Member Functions
	AntiochConstantTransportMixture (const GetPot &input, const std::string &material)

virtual	~AntiochConstantTransportMixture ()

libMesh::Real	mu () const

const Conductivity &	conductivity () const

const Antioch::ConstantLewisDiffusivity< libMesh::Real > &	diffusivity () const

Public Member Functions inherited from GRINS::AntiochMixture
	AntiochMixture (const GetPot &input, const std::string &material)

virtual	~AntiochMixture ()

virtual void	register_parameter (const std::string &param_name, libMesh::ParameterMultiAccessor< libMesh::Number > &param_pointer) const
	Each subclass will register its copy of an independent. More...

const Antioch::ReactionSet< libMesh::Real > &	reaction_set () const

const Antioch::CEAThermoMixture< libMesh::Real > &	cea_mixture () const

libMesh::Real	h_stat_mech_ref_correction (unsigned int species) const

Public Member Functions inherited from GRINS::AntiochChemistry
	AntiochChemistry (const GetPot &input, const std::string &material)

virtual	~AntiochChemistry ()

libMesh::Real	M (unsigned int species) const
	Species molar mass (molecular weight), [kg/mol]. More...

libMesh::Real	M_mix (const std::vector< libMesh::Real > &mass_fractions) const
	Mixture molar mass (molecular weight), [kg/mol]. More...

libMesh::Real	R (unsigned int species) const
	Species gas constant, [J/kg-K]. More...

libMesh::Real	R_mix (const std::vector< libMesh::Real > &mass_fractions) const
	Mixture gas constant, [J/kg-K]. More...

libMesh::Real	X (unsigned int species, libMesh::Real M, libMesh::Real mass_fraction) const
	Species mole fraction, unitless. More...

void	X (libMesh::Real M, const std::vector< libMesh::Real > &mass_fractions, std::vector< libMesh::Real > &mole_fractions) const
	Mole fraction for all species, unitless. More...

libMesh::Real	molar_density (const unsigned int species, const libMesh::Real rho, const libMesh::Real mass_fraction) const
	Species molar density, [mol/m^3]. More...

void	molar_densities (const libMesh::Real rho, const std::vector< libMesh::Real > &mass_fractions, std::vector< libMesh::Real > &molar_densities) const
	Molar density for all species, [mol/m^3]. More...

unsigned int	n_species () const

unsigned int	species_index (const std::string &species_name) const

std::string	species_name (unsigned int species_index) const

const Antioch::ChemicalMixture< libMesh::Real > &	chemical_mixture () const
	Accessor to underlying Antioch object. More...

const AntiochChemistry &	chemistry () const
	Accessor for this class. More...

Public Member Functions inherited from GRINS::ParameterUser
	ParameterUser (const std::string &user_name)

virtual	~ParameterUser ()

virtual void	set_parameter (libMesh::Number &param_variable, const GetPot &input, const std::string &param_name, libMesh::Number param_default)
	Each subclass can simultaneously read a parameter value from. More...

virtual void	set_parameter (libMesh::ParsedFunction< libMesh::Number, libMesh::Gradient > &func, const GetPot &input, const std::string &func_param_name, const std::string &param_default)
	Each subclass can simultaneously read a parsed function from. More...

virtual void	set_parameter (libMesh::ParsedFEMFunction< libMesh::Number > &func, const GetPot &input, const std::string &func_param_name, const std::string &param_default)
	Each subclass can simultaneously read a parsed function from. More...

virtual void	move_parameter (const libMesh::Number &old_parameter, libMesh::Number &new_parameter)
	When cloning an object, we need to update parameter pointers. More...

virtual void	move_parameter (const libMesh::ParsedFunction< libMesh::Number, libMesh::Gradient > &old_func, libMesh::ParsedFunction< libMesh::Number, libMesh::Gradient > &new_func)
	When cloning an object, we need to update parameter pointers. More...

virtual void	move_parameter (const libMesh::ParsedFEMFunction< libMesh::Number > &old_func, libMesh::ParsedFEMFunction< libMesh::Number > &new_func)
	When cloning an object, we need to update parameter pointers. More...

Protected Member Functions
void	build_conductivity (const GetPot &input, const std::string &material)

Protected Member Functions inherited from GRINS::AntiochMixture
void	build_stat_mech_ref_correction ()

Protected Attributes
libMesh::UniquePtr< ConstantViscosity >	_mu
	Viscosity. More...

libMesh::UniquePtr< Conductivity >	_conductivity
	Thermal conductivity. More...

libMesh::UniquePtr< Antioch::ConstantLewisDiffusivity< libMesh::Real > >	_diffusivity

Protected Attributes inherited from GRINS::AntiochMixture
libMesh::UniquePtr< Antioch::ReactionSet< libMesh::Real > >	_reaction_set

libMesh::UniquePtr< Antioch::CEAThermoMixture< libMesh::Real > >	_cea_mixture

std::vector< libMesh::Real >	_h_stat_mech_ref_correction

Protected Attributes inherited from GRINS::AntiochChemistry
libMesh::UniquePtr< Antioch::ChemicalMixture< libMesh::Real > >	_antioch_gas

Private Member Functions
	AntiochConstantTransportMixture ()

void	specialized_build_conductivity (const GetPot &input, const std::string &material, libMesh::UniquePtr< ConstantConductivity > &conductivity, conductivity_type< ConstantConductivity >)

void	specialized_build_conductivity (const GetPot &input, const std::string &material, libMesh::UniquePtr< ConstantPrandtlConductivity > &conductivity, conductivity_type< ConstantPrandtlConductivity >)

Additional Inherited Members
Static Public Attributes inherited from GRINS::ParameterUser
static std::string	zero_vector_function = std::string("{0}")
	A parseable function string with LIBMESH_DIM components, all 0. More...

Detailed Description

template<typename Conductivity>
class GRINS::AntiochConstantTransportMixture< Conductivity >

Wrapper class for storing state for constant transport properties, including Antioch::ConstantLewisDiffusivity.

This class is expected to be constructed before threads have been forked and will live during the whole program. By default, Antioch is working in SI units. Note that this documentation will always be built regardless if Antioch is included in the GRINS build or not. Check configure output to confirm that Antioch was included in the build.

Definition at line 58 of file antioch_constant_transport_mixture.h.

Member Typedef Documentation

template<typename Conductivity>

typedef AntiochChemistry GRINS::AntiochConstantTransportMixture< Conductivity >::ChemistryParent

Definition at line 72 of file antioch_constant_transport_mixture.h.

Constructor & Destructor Documentation

template<typename Thermo >

GRINS::AntiochConstantTransportMixture< Thermo >::AntiochConstantTransportMixture	(	const GetPot &	input,
		const std::string &	material
	)

Definition at line 39 of file antioch_constant_transport_mixture.C.

References GRINS::AntiochConstantTransportMixture< Conductivity >::_diffusivity, GRINS::AntiochConstantTransportMixture< Conductivity >::_mu, GRINS::AntiochConstantTransportMixture< Conductivity >::build_conductivity(), and GRINS::MaterialsParsing::parse_lewis_number().

     : AntiochMixture(input,material)
   {
     libMesh::Real Le = MaterialsParsing::parse_lewis_number(input,material);
     _diffusivity.reset( new Antioch::ConstantLewisDiffusivity<libMesh::Real>(Le) );
     _mu.reset( new ConstantViscosity(input,material) );
     this->build_conductivity(input,material);
 
     return;
   }

template<typename Thermo >

GRINS::AntiochConstantTransportMixture< Thermo >::~AntiochConstantTransportMixture ( )

virtual

Definition at line 52 of file antioch_constant_transport_mixture.C.

   {
     return;
   }

template<typename Conductivity>

GRINS::AntiochConstantTransportMixture< Conductivity >::AntiochConstantTransportMixture ( )

private

Member Function Documentation

template<typename Conductivity>

void GRINS::AntiochConstantTransportMixture< Conductivity >::build_conductivity	(	const GetPot &	input,
		const std::string &	material
	)

inlineprotected

Definition at line 91 of file antioch_constant_transport_mixture.h.

References GRINS::AntiochConstantTransportMixture< Conductivity >::specialized_build_conductivity().

Referenced by GRINS::AntiochConstantTransportMixture< Conductivity >::AntiochConstantTransportMixture().

92 { specialized_build_conductivity( input, material, _conductivity, conductivity_type<Conductivity>() ); }

GRINS::AntiochConstantTransportMixture::specialized_build_conductivity

void specialized_build_conductivity(const GetPot &input, const std::string &material, libMesh::UniquePtr< ConstantConductivity > &conductivity, conductivity_type< ConstantConductivity >)

Definition: antioch_constant_transport_mixture.h:98

GRINS::AntiochConstantTransportMixture::_conductivity

libMesh::UniquePtr< Conductivity > _conductivity

Thermal conductivity.

Definition: antioch_constant_transport_mixture.h:83

template<typename Conductivity >

const Conductivity & GRINS::AntiochConstantTransportMixture< Conductivity >::conductivity ( ) const

inline

Definition at line 126 of file antioch_constant_transport_mixture.h.

   {
     return *_conductivity.get();
   }

template<typename Conductivity >

const Antioch::ConstantLewisDiffusivity< libMesh::Real > & GRINS::AntiochConstantTransportMixture< Conductivity >::diffusivity ( ) const

inline

Definition at line 133 of file antioch_constant_transport_mixture.h.

   {
     return *_diffusivity.get();
   }

template<typename Conductivity >

libMesh::Real GRINS::AntiochConstantTransportMixture< Conductivity >::mu ( ) const

inline

Definition at line 119 of file antioch_constant_transport_mixture.h.

   {
     return (*_mu)();
   }

template<typename Conductivity>

void GRINS::AntiochConstantTransportMixture< Conductivity >::specialized_build_conductivity	(	const GetPot &	input,
		const std::string &	material,
		libMesh::UniquePtr< ConstantConductivity > &	conductivity,
		conductivity_type< ConstantConductivity >
	)

inlineprivate

Definition at line 98 of file antioch_constant_transport_mixture.h.

Referenced by GRINS::AntiochConstantTransportMixture< Conductivity >::build_conductivity().

     {
       conductivity.reset( new ConstantConductivity(input,material) );
       return;
     }

template<typename Conductivity>

void GRINS::AntiochConstantTransportMixture< Conductivity >::specialized_build_conductivity	(	const GetPot &	input,
		const std::string &	material,
		libMesh::UniquePtr< ConstantPrandtlConductivity > &	conductivity,
		conductivity_type< ConstantPrandtlConductivity >
	)

inlineprivate

Definition at line 106 of file antioch_constant_transport_mixture.h.

     {
       conductivity.reset( new ConstantPrandtlConductivity(input,material) );
       return;
     }

Member Data Documentation

template<typename Conductivity>

libMesh::UniquePtr<Conductivity> GRINS::AntiochConstantTransportMixture< Conductivity >::_conductivity

protected

Thermal conductivity.

Definition at line 83 of file antioch_constant_transport_mixture.h.

template<typename Conductivity>

libMesh::UniquePtr<Antioch::ConstantLewisDiffusivity<libMesh::Real> > GRINS::AntiochConstantTransportMixture< Conductivity >::_diffusivity

protected

Definition at line 85 of file antioch_constant_transport_mixture.h.

Referenced by GRINS::AntiochConstantTransportMixture< Conductivity >::AntiochConstantTransportMixture().

template<typename Conductivity>

libMesh::UniquePtr<ConstantViscosity> GRINS::AntiochConstantTransportMixture< Conductivity >::_mu

protected

Viscosity.

Todo:: Template on viscosity model, as we did for conductivity, to support parsed versions. This is going to require we update the API for the transport wrappers.

Definition at line 80 of file antioch_constant_transport_mixture.h.

Referenced by GRINS::AntiochConstantTransportMixture< Conductivity >::AntiochConstantTransportMixture().

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

src/properties/include/grins/antioch_constant_transport_mixture.h
src/properties/src/antioch_constant_transport_mixture.C

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Additional Inherited Members

Detailed Description

template<typename Conductivity> class GRINS::AntiochConstantTransportMixture< Conductivity >

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

template<typename Conductivity>
class GRINS::AntiochConstantTransportMixture< Conductivity >