Inheritance diagram for dragModel:

Collaboration diagram for dragModel:

Public Member Functions
	TypeName ("dragModel")
	Runtime type information. More...

	declareRunTimeSelectionTable (autoPtr, dragModel, dictionary,(const dictionary &dict, const phasePair &pair, const bool registerObject),(dict, pair, registerObject))

	dragModel (const phasePair &pair, const bool registerObject)

	dragModel (const dictionary &dict, const phasePair &pair, const bool registerObject)

virtual	~dragModel ()
	Destructor. More...

virtual tmp< volScalarField >	CdRe () const =0
	Drag coefficient. More...

virtual tmp< volScalarField >	Ki () const
	Return the phase-intensive drag coefficient Ki. More...

virtual tmp< volScalarField >	K () const
	Return the drag coefficient K. More...

virtual tmp< surfaceScalarField >	Kf () const
	Return the drag coefficient Kf. More...

bool	writeData (Ostream &os) const
	Dummy write for regIOobject. More...

	TypeName ("dragModel")
	Runtime type information. More...

	declareRunTimeSelectionTable (autoPtr, dragModel, dictionary,(const dictionary &interfaceDict, const phaseModel &phase1, const phaseModel &phase2),(interfaceDict, phase1, phase2))

	dragModel (const dictionary &interfaceDict, const phaseModel &phase1, const phaseModel &phase2)

virtual	~dragModel ()
	Destructor. More...

const phaseModel &	phase1 () const

const phaseModel &	phase2 () const

const dimensionedScalar &	residualPhaseFraction () const

const dimensionedScalar &	residualSlip () const

virtual tmp< volScalarField >	K (const volScalarField &Ur) const =0
	The drag function K used in the momentum eq. More...

	TypeName ("dragModel")
	Runtime type information. More...

	declareRunTimeSelectionTable (autoPtr, dragModel, dictionary,(const dictionary &dict, const phasePair &pair, const bool registerObject),(dict, pair, registerObject))

	dragModel (const phasePair &pair, const bool registerObject)

	dragModel (const dictionary &dict, const phasePair &pair, const bool registerObject)

virtual	~dragModel ()
	Destructor. More...

virtual tmp< volScalarField >	CdRe () const =0
	Drag coefficient. More...

virtual tmp< volScalarField >	Ki () const
	Return the phase-intensive drag coefficient Ki. More...

virtual tmp< volScalarField >	K () const
	Return the drag coefficient K. More...

virtual tmp< surfaceScalarField >	Kf () const
	Return the drag coefficient Kf. More...

bool	writeData (Ostream &os) const
	Dummy write for regIOobject. More...

Public Member Functions inherited from regIOobject
	TypeName ("regIOobject")
	Runtime type information. More...

	regIOobject (const IOobject &io, const bool isTime=false)

	regIOobject (const regIOobject &rio)
	Copy construct. More...

	regIOobject (const regIOobject &rio, bool registerCopy)

	regIOobject (const word &newName, const regIOobject &, bool registerCopy)

	regIOobject (const IOobject &io, const regIOobject &rio)
	Copy construct with new IO parameters. More...

virtual	~regIOobject ()
	Destructor. More...

bool	checkIn ()
	Add object to registry, if not already registered. More...

bool	checkOut ()
	Remove all file watches and remove object from registry. More...

virtual void	addWatch ()
	Add file watch on object (if registered and READ_IF_MODIFIED) More...

bool	ownedByRegistry () const
	Is this object owned by the registry? More...

void	store ()
	Transfer ownership of this object to its registry. More...

void	release (const bool unregister=false)
	Release ownership of this object from its registry. More...

label	eventNo () const
	Event number at last update. More...

label &	eventNo ()
	Event number at last update. More...

bool	upToDate (const regIOobject &) const
	Return true if up-to-date with respect to given object. More...

bool	upToDate (const regIOobject &, const regIOobject &) const
	Return true if up-to-date with respect to given objects. More...

bool	upToDate (const regIOobject &, const regIOobject &, const regIOobject &) const
	Return true if up-to-date with respect to given objects. More...

bool	upToDate (const regIOobject &, const regIOobject &, const regIOobject &, const regIOobject &) const
	Return true if up-to-date with respect to given objects. More...

void	setUpToDate ()
	Set as up-to-date. More...

virtual void	rename (const word &newName)
	Rename. More...

virtual fileName	filePath () const
	Return complete path + object name if the file exists. More...

bool	headerOk ()
	Read and check header info. More...

Istream &	readStream (const word &, const bool valid=true)
	Return Istream and check object type against that given. More...

void	close ()
	Close Istream. More...

virtual bool	readData (Istream &)
	Virtual readData function. More...

virtual bool	read ()
	Read object. More...

virtual label	addWatch (const fileName &)
	Add file watch for fileName on object if not yet watched. Return. More...

const labelList &	watchIndices () const
	Return file-monitoring handles. More...

labelList &	watchIndices ()
	Return file-monitoring handles. More...

virtual bool	modified () const
	Return true if the object's file (or files for objectRegistry) More...

virtual bool	readIfModified ()
	Read object if modified (as set by call to modified) More...

virtual bool	writeObject (IOstream::streamFormat, IOstream::versionNumber, IOstream::compressionType, const bool valid) const
	Write using given format, version and compression. More...

virtual bool	write (const bool valid=true) const
	Write using setting from DB. More...

virtual bool	global () const
	Is object global. More...

void	operator= (const IOobject &)

Public Member Functions inherited from IOobject
	TypeName ("IOobject")
	Runtime type information. More...

	IOobject (const word &name, const fileName &instance, const objectRegistry &registry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true)
	Construct from name, instance, registry, io options. More...

	IOobject (const word &name, const fileName &instance, const fileName &local, const objectRegistry &registry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true, bool globalObject=false)
	Construct from name, instance, local, registry, io options. More...

	IOobject (const fileName &path, const objectRegistry &registry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true, bool globalObject=false)
	Construct from path, registry, io options. More...

	IOobject (const IOobject &io, const objectRegistry &registry)
	Construct as copy resetting registry. More...

	IOobject (const IOobject &io, const word &name)
	Construct as copy resetting name. More...

autoPtr< IOobject >	clone () const
	Clone. More...

autoPtr< IOobject >	clone (const objectRegistry &registry) const
	Clone resetting registry. More...

virtual	~IOobject ()=default
	Destructor. More...

const objectRegistry &	db () const
	Return the local objectRegistry. More...

const Time &	time () const
	Return time. More...

const word &	name () const
	Return name. More...

const word &	headerClassName () const
	Return name of the class name read from header. More...

word &	headerClassName ()
	Return non-constant access to the class name read from header. More...

const string &	note () const
	Return the optional note. More...

string &	note ()
	Return non-constant access to the optional note. More...

bool	registerObject () const
	Should object created with this IOobject be registered? More...

bool &	registerObject ()
	Should object created with this IOobject be registered? More...

bool	globalObject () const
	Is object same for all processors? More...

bool &	globalObject ()
	Is object same for all processors? More...

unsigned	labelByteSize () const
	The label byte-size, possibly read from the header. More...

unsigned	scalarByteSize () const
	The scalar byte-size, possibly read from the header. More...

bool	isHeaderClassName (const word &clsName) const
	Test if headerClassName() equals the given class name. More...

template<class Type >
bool	isHeaderClassName () const
	Test if headerClassName() equals Type::typeName. More...

readOption	readOpt () const
	The read option. More...

readOption &	readOpt ()
	Non-constant access to the read option. More...

writeOption	writeOpt () const
	The write option. More...

writeOption &	writeOpt ()
	Non-constant access to the write option. More...

word	group () const
	Return group (extension part of name) More...

word	member () const
	Return member (name without the extension) More...

const fileName &	rootPath () const

const fileName &	caseName () const

const fileName &	instance () const

fileName &	instance ()

const fileName &	local () const

fileName	path () const
	The complete path. More...

fileName	path (const word &instance, const fileName &local=fileName::null) const
	The complete path with alternative instance and local. More...

fileName	objectPath () const
	The complete path + object name. More...

fileName	localFilePath (const word &typeName, const bool search=true) const
	Helper for filePath that searches locally. More...

fileName	globalFilePath (const word &typeName, const bool search=true) const
	Helper for filePath that searches up if in parallel. More...

bool	readHeader (Istream &is)
	Read header. More...

template<class Type >
bool	typeHeaderOk (const bool checkType=true, const bool search=true, const bool verbose=true)
	Read header (uses typeFilePath to find file) and check its info. More...

template<class Type >
void	warnNoRereading () const
	Helper: warn that type does not support re-reading. More...

bool	writeHeader (Ostream &os) const
	Write header. More...

bool	writeHeader (Ostream &os, const word &objectType) const
	Write header. Allow override of type. More...

bool	good () const

bool	bad () const

InfoProxy< IOobject >	info () const
	Return info proxy. More...

void	operator= (const IOobject &io)

template<>
bool	isHeaderClassName () const
	Specialization for `void` always returns true (no headerClassName check). More...

template<class StringType >
Foam::word	groupName (StringType name, const word &group)

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

static autoPtr< dragModel >	New (const dictionary &interfaceDict, const phaseModel &phase1, const phaseModel &phase2)

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

Static Public Member Functions inherited from regIOobject
template<class Type >
static Type &	store (Type *p)
	Transfer ownership of the given object pointer to its registry. More...

template<class Type >
static Type &	store (autoPtr< Type > &aptr)
	Transfer ownership of the given object pointer to its registry. More...

template<class Type >
static Type &	store (autoPtr< Type > &&aptr)
	Transfer ownership of the given object pointer to its registry. More...

Static Public Member Functions inherited from IOobject
static bool	fileNameComponents (const fileName &path, fileName &instance, fileName &local, word &name)
	Split path into instance, local, name components. More...

template<class StringType >
static word	groupName (StringType name, const word &group)
	Create dot-delimited name.group. More...

static word	group (const word &name)
	Return group (extension part of name) More...

static word	member (const word &name)
	Return member (name without the extension) More...

static IOobject	selectIO (const IOobject &io, const fileName &altFile, const word &ioName="")
	Return the IOobject, but also consider an alternative file name. More...

static Ostream &	writeBanner (Ostream &os, bool noHint=false)
	Write the standard OpenFOAM file/dictionary banner. More...

static Ostream &	writeDivider (Ostream &os)
	Write the standard file section divider. More...

static Ostream &	writeEndDivider (Ostream &os)
	Write the standard end file divider. More...

Static Public Attributes
static const dimensionSet	dimK
	Coefficient dimensions. More...

Static Public Attributes inherited from regIOobject
static float	fileModificationSkew

static int	maxFileModificationPolls

Static Public Attributes inherited from IOobject
static const Enum< fileCheckTypes >	fileCheckTypesNames
	Names for the fileCheckTypes. More...

static fileCheckTypes	fileModificationChecking
	Type of file modification checking. More...

Protected Attributes
const phasePair &	pair_
	Phase pair. More...

autoPtr< swarmCorrection >	swarmCorrection_
	Swarm correction. More...

const dictionary &	interfaceDict_

const phaseModel &	phase1_

const phaseModel &	phase2_

dimensionedScalar	residualPhaseFraction_

dimensionedScalar	residualSlip_

Additional Inherited Members
Public Types inherited from IOobject
enum	objectState : char { GOOD, BAD }
	Enumeration defining the valid states of an IOobject. More...

enum	readOption : char { MUST_READ, MUST_READ_IF_MODIFIED, READ_IF_PRESENT, NO_READ }
	Enumeration defining the read options. More...

enum	writeOption : char { AUTO_WRITE = 0, NO_WRITE = 1 }
	Enumeration defining the write options. More...

enum	fileCheckTypes : char { timeStamp, timeStampMaster, inotify, inotifyMaster }
	Enumeration defining the file checking options. More...

Protected Member Functions inherited from regIOobject
bool	readHeaderOk (const IOstream::streamFormat PstreamFormat, const word &typeName)
	Helper: check readOpt flags and read if necessary. More...

Istream *	objectStream ()
	Construct and return an IFstream for the object. More...

Protected Member Functions inherited from IOobject
void	setBad (const string &s)
	Set the object state to bad. More...

Static Protected Attributes inherited from regIOobject
static bool	masterOnlyReading = false
	To flag master-only reading of objects. More...

Detailed Description

Source files

Definition at line 55 of file dragModel.H.

Constructor & Destructor Documentation

◆ dragModel() [1/5]

dragModel	(	const phasePair &	pair,
		const bool	registerObject
	)

Definition at line 49 of file dragModel.C.

◆ dragModel() [2/5]

dragModel	(	const dictionary &	dict,
		const phasePair &	pair,
		const bool	registerObject
	)

Definition at line 71 of file dragModel.C.

◆ ~dragModel() [1/3]

~dragModel ( )

virtual

Destructor.

Definition at line 103 of file dragModel.C.

◆ dragModel() [3/5]

dragModel	(	const dictionary &	interfaceDict,
		const phaseModel &	phase1,
		const phaseModel &	phase2
	)

◆ ~dragModel() [2/3]

virtual ~dragModel ( )

virtual

Destructor.

◆ dragModel() [4/5]

dragModel	(	const phasePair &	pair,
		const bool	registerObject
	)

◆ dragModel() [5/5]

dragModel	(	const dictionary &	dict,
		const phasePair &	pair,
		const bool	registerObject
	)

◆ ~dragModel() [3/3]

virtual ~dragModel ( )

virtual

Destructor.

Member Function Documentation

◆ TypeName() [1/3]

TypeName ( "dragModel" )

Runtime type information.

◆ declareRunTimeSelectionTable() [1/3]

declareRunTimeSelectionTable	(	autoPtr	,
		dragModel	,
		dictionary	,
		(const dictionary &dict, const phasePair &pair, const bool registerObject)	,
		(dict, pair, registerObject)
	)

◆ New() [1/3]

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

static

Definition at line 35 of file newDragModel.C.

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

Here is the call graph for this function:

◆ CdRe() [1/2]

virtual tmp<volScalarField> CdRe ( ) const

pure virtual

Drag coefficient.

Implemented in AttouFerschneider, TomiyamaAnalytic, GidaspowErgunWenYu, TomiyamaAnalytic, GidaspowSchillerNaumann, GidaspowSchillerNaumann, GidaspowErgunWenYu, Tenneti, TomiyamaKataokaZunSakaguchi, Beetstra, segregated, Lain, segregated, Lain, TomiyamaCorrelated, TomiyamaCorrelated, WenYu, WenYu, IshiiZuber, IshiiZuber, Gibilaro, SyamlalOBrien, Ergun, SchillerNaumann, SchillerNaumann, Ergun, Gibilaro, and SyamlalOBrien.

◆ Ki() [1/2]

Foam::tmp< Foam::volScalarField > Ki ( ) const

virtual

Return the phase-intensive drag coefficient Ki.

used in the momentum equations ddt(alpha1*rho1*U1) + ... = ... alphad*K*(U1-U2) ddt(alpha2*rho2*U2) + ... = ... alphad*K*(U2-U1)

Definition at line 109 of file dragModel.C.

References Foam::sqr().

Here is the call graph for this function:

◆ K() [1/3]

Foam::tmp< Foam::volScalarField > K ( ) const

virtual

Return the drag coefficient K.

used in the momentum equations ddt(alpha1*rho1*U1) + ... = ... K*(U1-U2) ddt(alpha2*rho2*U2) + ... = ... K*(U2-U1)

Reimplemented in AttouFerschneider, segregated, and segregated.

Definition at line 121 of file dragModel.C.

References Foam::max().

Here is the call graph for this function:

◆ Kf() [1/2]

Foam::tmp< Foam::surfaceScalarField > Kf ( ) const

virtual

Return the drag coefficient Kf.

used in the face-momentum equations

Reimplemented in AttouFerschneider, segregated, and segregated.

Definition at line 127 of file dragModel.C.

References Foam::fvc::interpolate(), and Foam::max().

Here is the call graph for this function:

◆ writeData() [1/2]

bool writeData ( Ostream & os ) const

virtual

Dummy write for regIOobject.

Implements regIOobject.

Definition at line 138 of file dragModel.C.

References IOstream::good().

Here is the call graph for this function:

◆ TypeName() [2/3]

TypeName ( "dragModel" )

Runtime type information.

◆ declareRunTimeSelectionTable() [2/3]

declareRunTimeSelectionTable	(	autoPtr	,
		dragModel	,
		dictionary	,
		(const dictionary &interfaceDict, const phaseModel &phase1, const phaseModel &phase2)	,
		(interfaceDict, phase1, phase2)
	)

◆ New() [2/3]

static autoPtr<dragModel> New	(	const dictionary &	interfaceDict,
		const phaseModel &	phase1,
		const phaseModel &	phase2
	)

static

◆ phase1()

const phaseModel& phase1 ( ) const

inline

Definition at line 112 of file dragModel.H.

References dragModel::phase1_.

◆ phase2()

const phaseModel& phase2 ( ) const

inline

Definition at line 117 of file dragModel.H.

References dragModel::phase2_.

◆ residualPhaseFraction()

const dimensionedScalar& residualPhaseFraction ( ) const

inline

Definition at line 122 of file dragModel.H.

References dragModel::residualPhaseFraction_.

◆ residualSlip()

const dimensionedScalar& residualSlip ( ) const

inline

Definition at line 127 of file dragModel.H.

References dragModel::residualSlip_.

◆ K() [2/3]

virtual tmp<volScalarField> K ( const volScalarField & Ur ) const

pure virtual

The drag function K used in the momentum eq.

ddt(alpha1*rho1*U1) + ... = ... alpha1*alpha2*K*(U1-U2) ddt(alpha2*rho2*U2) + ... = ... alpha1*alpha2*K*(U2-U1) NB! ***************************** for numerical reasons alpha1 and alpha2 has been extracted from the dragFunction K, so you MUST divide K by alpha1*alpha2 when implementing the drag function NB! *****************************

Implemented in WenYu, GidaspowSchillerNaumann, blended, Ergun, Gibilaro, SyamlalOBrien, GidaspowErgunWenYu, interface, and SchillerNaumann.

◆ TypeName() [3/3]

TypeName ( "dragModel" )

Runtime type information.

◆ declareRunTimeSelectionTable() [3/3]

declareRunTimeSelectionTable	(	autoPtr	,
		dragModel	,
		dictionary	,
		(const dictionary &dict, const phasePair &pair, const bool registerObject)	,
		(dict, pair, registerObject)
	)

◆ New() [3/3]

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

static

◆ CdRe() [2/2]

virtual tmp<volScalarField> CdRe ( ) const

pure virtual

Drag coefficient.

Implemented in AttouFerschneider, TomiyamaAnalytic, GidaspowErgunWenYu, TomiyamaAnalytic, GidaspowSchillerNaumann, GidaspowSchillerNaumann, GidaspowErgunWenYu, Tenneti, TomiyamaKataokaZunSakaguchi, Beetstra, segregated, Lain, segregated, Lain, TomiyamaCorrelated, TomiyamaCorrelated, WenYu, WenYu, IshiiZuber, IshiiZuber, Gibilaro, SyamlalOBrien, Ergun, SchillerNaumann, SchillerNaumann, Ergun, Gibilaro, and SyamlalOBrien.

◆ Ki() [2/2]

virtual tmp<volScalarField> Ki ( ) const

virtual

Return the phase-intensive drag coefficient Ki.

used in the momentum equations ddt(alpha1*rho1*U1) + ... = ... alphad*K*(U1-U2) ddt(alpha2*rho2*U2) + ... = ... alphad*K*(U2-U1)

◆ K() [3/3]

virtual tmp<volScalarField> K ( ) const

virtual

Return the drag coefficient K.

used in the momentum equations ddt(alpha1*rho1*U1) + ... = ... K*(U1-U2) ddt(alpha2*rho2*U2) + ... = ... K*(U2-U1)

Reimplemented in AttouFerschneider, segregated, and segregated.

◆ Kf() [2/2]

virtual tmp<surfaceScalarField> Kf ( ) const

virtual

Return the drag coefficient Kf.

used in the face-momentum equations

Reimplemented in AttouFerschneider, segregated, and segregated.

◆ writeData() [2/2]

bool writeData ( Ostream & os ) const

virtual

Dummy write for regIOobject.

Implements regIOobject.

Member Data Documentation

◆ pair_

const phasePair & pair_

protected

Phase pair.

Definition at line 64 of file dragModel.H.

◆ swarmCorrection_

autoPtr< swarmCorrection > swarmCorrection_

protected

Swarm correction.

Definition at line 67 of file dragModel.H.

◆ dimK

static const dimensionSet dimK

static

Coefficient dimensions.

Definition at line 95 of file dragModel.H.

◆ interfaceDict_

const dictionary& interfaceDict_

protected

Definition at line 58 of file dragModel.H.

◆ phase1_

const phaseModel& phase1_

protected

Definition at line 59 of file dragModel.H.

Referenced by dragModel::phase1().

◆ phase2_

const phaseModel& phase2_

protected

Definition at line 60 of file dragModel.H.

Referenced by dragModel::phase2().

◆ residualPhaseFraction_

dimensionedScalar residualPhaseFraction_

protected

Definition at line 61 of file dragModel.H.

Referenced by dragModel::residualPhaseFraction().

◆ residualSlip_

dimensionedScalar residualSlip_

protected

Definition at line 62 of file dragModel.H.

Referenced by dragModel::residualSlip().

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

src/phaseSystemModels/reactingEulerFoam/interfacialModels/dragModels/dragModel/dragModel.H
src/phaseSystemModels/reactingEulerFoam/interfacialModels/dragModels/dragModel/dragModel.C
src/phaseSystemModels/reactingEulerFoam/interfacialModels/dragModels/dragModel/newDragModel.C

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ dragModel() [1/5]

◆ dragModel() [2/5]

◆ ~dragModel() [1/3]

◆ dragModel() [3/5]

◆ ~dragModel() [2/3]

◆ dragModel() [4/5]

◆ dragModel() [5/5]

◆ ~dragModel() [3/3]

Member Function Documentation

◆ TypeName() [1/3]

◆ declareRunTimeSelectionTable() [1/3]

◆ New() [1/3]

◆ CdRe() [1/2]

◆ Ki() [1/2]

◆ K() [1/3]

◆ Kf() [1/2]

◆ writeData() [1/2]

◆ TypeName() [2/3]

◆ declareRunTimeSelectionTable() [2/3]

◆ New() [2/3]

◆ phase1()

◆ phase2()

◆ residualPhaseFraction()

◆ residualSlip()

◆ K() [2/3]

◆ TypeName() [3/3]

◆ declareRunTimeSelectionTable() [3/3]

◆ New() [3/3]

◆ CdRe() [2/2]

◆ Ki() [2/2]

◆ K() [3/3]

◆ Kf() [2/2]

◆ writeData() [2/2]

Member Data Documentation

◆ pair_

◆ swarmCorrection_

◆ dimK

◆ interfaceDict_

◆ phase1_

◆ phase2_

◆ residualPhaseFraction_

◆ residualSlip_