swarmCorrection Class Reference

#include <swarmCorrection.H>

Inheritance diagram for swarmCorrection:

Collaboration diagram for swarmCorrection:

Public Member Functions
	TypeName ("swarmCorrection")
	Runtime type information.
	declareRunTimeSelectionTable (autoPtr, swarmCorrection, dictionary,(const dictionary &dict, const phasePair &pair),(dict, pair))
	swarmCorrection (const dictionary &dict, const phasePair &pair)
	Construct from a dictionary and a phase pair.
virtual	~swarmCorrection ()=default
	Destructor.
virtual tmp< volScalarField >	Cs () const =0
	Swarm correction coefficient.
	TypeName ("swarmCorrection")
	Runtime type information.
	declareRunTimeSelectionTable (autoPtr, swarmCorrection, dictionary,(const dictionary &dict, const phasePair &pair),(dict, pair))
	swarmCorrection (const dictionary &dict, const phasePair &pair)
	Construct from a dictionary and a phase pair.
virtual	~swarmCorrection ()=default
	Destructor.
virtual tmp< volScalarField >	Cs () const =0
	Swarm correction coefficient.

Static Public Member Functions
static autoPtr< swarmCorrection >	New (const dictionary &dict, const phasePair &pair)
static autoPtr< swarmCorrection >	New (const dictionary &dict, const phasePair &pair)

Protected Attributes
const phasePair &	pair_
	Phase pair.

Detailed Description

Source files

• swarmCorrection.H
• swarmCorrection.C

Source files

• swarmCorrection.H
• swarmCorrection.C

Definition at line 51 of file swarmCorrection.H.

Constructor & Destructor Documentation

swarmCorrection() [1/2]

swarmCorrection	(	const dictionary &	dict,
		const phasePair &	pair )

Construct from a dictionary and a phase pair.

Definition at line 36 of file swarmCorrection.C.

References dict, and pair_.

Referenced by declareRunTimeSelectionTable(), noSwarm::noSwarm(), and TomiyamaSwarm::TomiyamaSwarm().

Here is the caller graph for this function:

~swarmCorrection() [1/2]

virtual ~swarmCorrection ( )

virtualdefault

Destructor.

References dict.

swarmCorrection() [2/2]

swarmCorrection	(	const dictionary &	dict,
		const phasePair &	pair )

Construct from a dictionary and a phase pair.

References dict.

~swarmCorrection() [2/2]

virtual ~swarmCorrection ( )

virtualdefault

Destructor.

Member Function Documentation

TypeName() [1/2]

TypeName

(

"swarmCorrection"

)

Runtime type information.

declareRunTimeSelectionTable() [1/2]

declareRunTimeSelectionTable	(	autoPtr	,
		swarmCorrection	,
		dictionary	,
		(const dictionary &dict, const phasePair &pair)	,
		(dict, pair)	)

References dict, and swarmCorrection().

Here is the call graph for this function:

New() [1/2]

Foam::autoPtr< Foam::swarmCorrection > New ( const dictionary & dict, const phasePair & pair )

static

Definition at line 49 of file swarmCorrection.C.

References Foam::abort(), dict, Foam::endl(), Foam::FatalIOError, FatalIOErrorInLookup, and Foam::Info.

Here is the call graph for this function:

Cs() [1/2]

virtual tmp< volScalarField > Cs ( ) const

pure virtual

Swarm correction coefficient.

Implemented in noSwarm, noSwarm, TomiyamaSwarm, and TomiyamaSwarm.

TypeName() [2/2]

TypeName

(

"swarmCorrection"

)

Runtime type information.

declareRunTimeSelectionTable() [2/2]

declareRunTimeSelectionTable	(	autoPtr	,
		swarmCorrection	,
		dictionary	,
		(const dictionary &dict, const phasePair &pair)	,
		(dict, pair)	)

References dict, and swarmCorrection().

Here is the call graph for this function:

New() [2/2]

autoPtr< swarmCorrection > New ( const dictionary & dict, const phasePair & pair )

static

References dict.

Cs() [2/2]

virtual tmp< volScalarField > Cs ( ) const

pure virtual

Swarm correction coefficient.

Implemented in noSwarm, noSwarm, TomiyamaSwarm, and TomiyamaSwarm.

Member Data Documentation

pair_

const phasePair & pair_

protected

Phase pair.

Definition at line 60 of file swarmCorrection.H.

Referenced by noSwarm::Cs(), TomiyamaSwarm::Cs(), swarmCorrection(), and TomiyamaSwarm::TomiyamaSwarm().

---

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

• src/phaseSystemModels/reactingEuler/multiphaseSystem/interfacialModels/swarmCorrections/swarmCorrection/swarmCorrection.H
• src/phaseSystemModels/twoPhaseEuler/twoPhaseSystem/interfacialModels/swarmCorrections/swarmCorrection/swarmCorrection.H
• src/phaseSystemModels/reactingEuler/multiphaseSystem/interfacialModels/swarmCorrections/swarmCorrection/swarmCorrection.C
• src/phaseSystemModels/twoPhaseEuler/twoPhaseSystem/interfacialModels/swarmCorrections/swarmCorrection/swarmCorrection.C