Multi-component mixture. More...

#include <basicMultiComponentMixture.H>

Inheritance diagram for basicMultiComponentMixture:

[legend]

Collaboration diagram for basicMultiComponentMixture:

[legend]

Public Types
typedef basicMultiComponentMixture	basicMixtureType
	The base class of the mixture.
Public Types inherited from basicMixture
typedef basicMixture	basicMixtureType
	The base class of the mixture.

Public Member Functions
	TypeName ("basicMultiComponentMixture")
	Run time type information.
	basicMultiComponentMixture (const dictionary &thermoDict, const wordList &specieNames, const fvMesh &mesh, const word &phaseName)
	Construct from dictionary, species names, mesh and phase name.
virtual	~basicMultiComponentMixture ()=default
	Destructor.
const speciesTable &	species () const
	Return the table of species.
bool	contains (const word &specieName) const
	Does the mixture include this specie?
bool	active (label speciei) const
	Return true for active species.
const List< bool > &	active () const
	Return the bool list of active species.
void	setActive (label speciei)
	Set speciei active.
void	setInactive (label speciei)
	Set speciei inactive.
PtrList< volScalarField > &	Y ()
	Return the mass-fraction fields.
const PtrList< volScalarField > &	Y () const
	Return the const mass-fraction fields.
volScalarField &	Y (const label i)
	Return the mass-fraction field for a specie given by index.
const volScalarField &	Y (const label i) const
	Return the const mass-fraction field for a specie given by index.
volScalarField &	Y (const word &specieName)
	Return the mass-fraction field for a specie given by name.
const volScalarField &	Y (const word &specieName) const
	Return the const mass-fraction field for a specie given by name.
Public Member Functions inherited from basicMixture
	basicMixture (const dictionary &, const fvMesh &, const word &)
	Construct from dictionary, mesh and phase name.

Protected Attributes
speciesTable	species_
	Table of specie names.
List< bool >	active_
	List of specie active flags.
PtrList< volScalarField >	Y_
	Species mass fractions.

Detailed Description

Multi-component mixture.

Provides a list of mass fraction fields and helper functions to query mixture composition.

Source files

Definition at line 56 of file basicMultiComponentMixture.H.

Member Typedef Documentation

◆ basicMixtureType

typedef basicMultiComponentMixture basicMixtureType

The base class of the mixture.

Definition at line 92 of file basicMultiComponentMixture.H.

Constructor & Destructor Documentation

◆ basicMultiComponentMixture()

basicMultiComponentMixture	(	const dictionary &	thermoDict,
		const wordList &	specieNames,
		const fvMesh &	mesh,
		const word &	phaseName )

Construct from dictionary, species names, mesh and phase name.

Definition at line 32 of file basicMultiComponentMixture.C.

References active_, IOobjectOption::AUTO_WRITE, basicMixture::basicMixture(), DebugInfo, Foam::endl(), forAll, IOobject::groupName(), mesh, IOobjectOption::MUST_READ, IOobjectOption::NO_READ, IOobjectOption::NO_REGISTER, IOobjectOption::NO_WRITE, species_, thermoDict, Time::timeName(), IOobject::typeHeaderOk(), tmp< T >::valid(), and Y_.

Referenced by basicSpecieMixture::basicSpecieMixture().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ~basicMultiComponentMixture()

virtual ~basicMultiComponentMixture ( )

virtualdefault

Destructor.

Member Function Documentation

◆ TypeName()

TypeName ( "basicMultiComponentMixture" )

Run time type information.

◆ species()

const Foam::speciesTable & species ( ) const

inline

Return the table of species.

Definition at line 22 of file basicMultiComponentMixtureI.H.

References species_.

Referenced by diffusionMulticomponent< ReactionThermo, ThermoType >::correct(), InterfaceCompositionModel< Thermo, OtherThermo >::getLocalThermo(), diffusionMulticomponent< ReactionThermo, ThermoType >::R(), ReactingCloud< CloudType >::ReactingCloud(), and SLGThermo::SLGThermo().

Here is the caller graph for this function:

◆ contains()

bool contains ( const word & specieName ) const

inline

Does the mixture include this specie?

Definition at line 28 of file basicMultiComponentMixtureI.H.

References species_.

◆ active() [1/2]

bool active ( label speciei ) const

inline

Return true for active species.

Definition at line 37 of file basicMultiComponentMixtureI.H.

References active_.

◆ active() [2/2]

const Foam::List< bool > & active ( ) const

inline

Return the bool list of active species.

Definition at line 43 of file basicMultiComponentMixtureI.H.

References active_.

◆ setActive()

void setActive ( label speciei )

inline

Set speciei active.

Definition at line 49 of file basicMultiComponentMixtureI.H.

References active_.

◆ setInactive()

void setInactive ( label speciei )

inline

Set speciei inactive.

Definition at line 55 of file basicMultiComponentMixtureI.H.

References active_.

◆ Y() [1/6]

Foam::PtrList< Foam::volScalarField > & Y ( )

inline

Return the mass-fraction fields.

Definition at line 62 of file basicMultiComponentMixtureI.H.

References Y_.

Referenced by diffusionMulticomponent< ReactionThermo, ThermoType >::correct(), and semiPermeableBaffleVelocityFvPatchVectorField::updateCoeffs().

Here is the caller graph for this function:

◆ Y() [2/6]

const Foam::PtrList< Foam::volScalarField > & Y ( ) const

inline

Return the const mass-fraction fields.

Definition at line 69 of file basicMultiComponentMixtureI.H.

References Y_.

◆ Y() [3/6]

Foam::volScalarField & Y ( const label i )

inline

Return the mass-fraction field for a specie given by index.

Definition at line 75 of file basicMultiComponentMixtureI.H.

References Y_.

◆ Y() [4/6]

const Foam::volScalarField & Y ( const label i ) const

inline

Return the const mass-fraction field for a specie given by index.

Definition at line 81 of file basicMultiComponentMixtureI.H.

References Y_.

◆ Y() [5/6]

Foam::volScalarField & Y ( const word & specieName )

inline

Return the mass-fraction field for a specie given by name.

Definition at line 90 of file basicMultiComponentMixtureI.H.

References species_, and Y_.

◆ Y() [6/6]

const Foam::volScalarField & Y ( const word & specieName ) const

inline

Return the const mass-fraction field for a specie given by name.

Definition at line 99 of file basicMultiComponentMixtureI.H.

References species_, and Y_.

Member Data Documentation

◆ species_

speciesTable species_

protected

Table of specie names.

Definition at line 68 of file basicMultiComponentMixture.H.

Referenced by basicMultiComponentMixture(), contains(), multiComponentMixture< ThermoType >::multiComponentMixture(), multiComponentMixture< ThermoType >::multiComponentMixture(), multiComponentMixture< ThermoType >::read(), singleStepReactingMixture< ThermoType >::singleStepReactingMixture(), species(), Y(), and Y().

◆ active_

List<bool> active_

protected

List of specie active flags.

Definition at line 73 of file basicMultiComponentMixture.H.

Referenced by active(), active(), basicMultiComponentMixture(), setActive(), and setInactive().

◆ Y_

PtrList<volScalarField> Y_

protected

Species mass fractions.

Definition at line 78 of file basicMultiComponentMixture.H.

Referenced by basicMultiComponentMixture(), multiComponentMixture< ThermoType >::cellMixture(), multiComponentMixture< ThermoType >::cellVolMixture(), multiComponentMixture< ThermoType >::patchFaceMixture(), multiComponentMixture< ThermoType >::patchFaceVolMixture(), Y(), Y(), Y(), Y(), Y(), and Y().

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

src/thermophysicalModels/reactionThermo/mixtures/basicMultiComponentMixture/basicMultiComponentMixture.H
src/thermophysicalModels/reactionThermo/mixtures/basicMultiComponentMixture/basicMultiComponentMixture.C
src/thermophysicalModels/reactionThermo/mixtures/basicMultiComponentMixture/basicMultiComponentMixtureI.H

Public Types

Public Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ basicMixtureType

Constructor & Destructor Documentation

◆ basicMultiComponentMixture()

◆ ~basicMultiComponentMixture()

Member Function Documentation

◆ TypeName()

◆ species()

◆ contains()

◆ active() [1/2]

◆ active() [2/2]

◆ setActive()

◆ setInactive()

◆ Y() [1/6]

◆ Y() [2/6]

◆ Y() [3/6]

◆ Y() [4/6]

◆ Y() [5/6]

◆ Y() [6/6]

Member Data Documentation

◆ species_

◆ active_

◆ Y_