List container for MRF zomes. More...

Inheritance diagram for MRFZoneList:

Collaboration diagram for MRFZoneList:

Public Member Functions
	MRFZoneList (const fvMesh &mesh, const dictionary &dict)
	Constructor. More...

	~MRFZoneList ()
	Destructor. More...

bool	active (const bool warn=false) const
	Return active status. More...

void	reset (const dictionary &dict)
	Reset the source list. More...

void	addAcceleration (const volVectorField &U, volVectorField &ddtU) const
	Add the frame acceleration. More...

void	addAcceleration (fvVectorMatrix &UEqn) const
	Add the frame acceleration contribution to the momentum equation. More...

void	addAcceleration (const volScalarField &rho, fvVectorMatrix &UEqn) const
	Add the frame acceleration contribution to the momentum equation. More...

tmp< volVectorField >	DDt (const volVectorField &U) const
	Return the frame acceleration. More...

tmp< volVectorField >	DDt (const volScalarField &rho, const volVectorField &U) const
	Return the frame acceleration. More...

void	makeRelative (volVectorField &U) const
	Make the given absolute velocity relative within the MRF region. More...

void	makeRelative (surfaceScalarField &phi) const
	Make the given absolute flux relative within the MRF region. More...

tmp< surfaceScalarField >	relative (const tmp< surfaceScalarField > &phi) const
	Return the given absolute flux relative within the MRF region. More...

tmp< FieldField< fvsPatchField, scalar > >	relative (const tmp< FieldField< fvsPatchField, scalar >> &tphi) const
	Return the given absolute boundary flux relative within. More...

tmp< Field< scalar > >	relative (const tmp< Field< scalar >> &tphi, const label patchi) const
	Return the given absolute patch flux relative within. More...

void	makeRelative (const surfaceScalarField &rho, surfaceScalarField &phi) const
	Make the given absolute mass-flux relative within the MRF region. More...

void	makeAbsolute (volVectorField &U) const
	Make the given relative velocity absolute within the MRF region. More...

void	makeAbsolute (surfaceScalarField &phi) const
	Make the given relative flux absolute within the MRF region. More...

tmp< surfaceScalarField >	absolute (const tmp< surfaceScalarField > &phi) const
	Return the given relative flux absolute within the MRF region. More...

void	makeAbsolute (const surfaceScalarField &rho, surfaceScalarField &phi) const
	Make the given relative mass-flux absolute within the MRF region. More...

void	correctBoundaryVelocity (volVectorField &U) const
	Correct the boundary velocity for the rotation of the MRF region. More...

void	correctBoundaryFlux (const volVectorField &U, surfaceScalarField &phi) const
	Correct the boundary flux for the rotation of the MRF region. More...

bool	read (const dictionary &dict)
	Read dictionary. More...

bool	writeData (Ostream &os) const
	Write data to Ostream. More...

Protected Attributes
const fvMesh &	mesh_
	Reference to the mesh database. More...

Friends
Ostream &	operator<< (Ostream &os, const MRFZoneList &models)
	Ostream operator. More...

Detailed Description

List container for MRF zomes.

Source files

Definition at line 55 of file MRFZoneList.H.

Constructor & Destructor Documentation

◆ MRFZoneList()

MRFZoneList	(	const fvMesh &	mesh,
		const dictionary &	dict
	)

Constructor.

Definition at line 33 of file MRFZoneList.C.

◆ ~MRFZoneList()

~MRFZoneList ( )

Destructor.

Definition at line 49 of file MRFZoneList.C.

Member Function Documentation

◆ active()

bool active ( const bool warn = false ) const

Return active status.

Definition at line 55 of file MRFZoneList.C.

References Foam::endl(), forAll, Foam::Info, UPtrList< T >::operator[](), and UPtrList< T >::size().

Here is the call graph for this function:

◆ reset()

void reset ( const dictionary & dict )

Reset the source list.

Definition at line 72 of file MRFZoneList.C.

References Foam::endl(), forAllConstIter(), Foam::Info, MRFZoneList::mesh_, Foam::name(), and PtrList< MRFZone >::setSize().

Here is the call graph for this function:

◆ addAcceleration() [1/3]

void addAcceleration	(	const volVectorField &	U,
		volVectorField &	ddtU
	)		const

Add the frame acceleration.

Definition at line 130 of file MRFZoneList.C.

References forAll, and UPtrList< T >::operator[]().

Referenced by MRFZoneList::addAcceleration(), and MRFZoneList::writeData().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ addAcceleration() [2/3]

void addAcceleration ( fvVectorMatrix & UEqn ) const

Add the frame acceleration contribution to the momentum equation.

Definition at line 142 of file MRFZoneList.C.

References MRFZoneList::addAcceleration(), forAll, and UPtrList< T >::operator[]().

Here is the call graph for this function:

◆ addAcceleration() [3/3]

void addAcceleration	(	const volScalarField &	rho,
		fvVectorMatrix &	UEqn
	)		const

Add the frame acceleration contribution to the momentum equation.

Definition at line 152 of file MRFZoneList.C.

References MRFZoneList::DDt(), forAll, and UPtrList< T >::operator[]().

Here is the call graph for this function:

◆ DDt() [1/2]

Foam::tmp< Foam::volVectorField > DDt ( const volVectorField & U ) const

Return the frame acceleration.

Definition at line 165 of file MRFZoneList.C.

References DimensionedField< Type, GeoMesh >::dimensions(), Foam::dimTime, forAll, DimensionedField< Type, GeoMesh >::mesh(), UPtrList< T >::operator[](), GeometricField< Type, PatchField, GeoMesh >::ref(), and Foam::Zero.

Referenced by MRFZoneList::addAcceleration(), and MRFZoneList::DDt().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ DDt() [2/2]

Foam::tmp< Foam::volVectorField > DDt	(	const volScalarField &	rho,
		const volVectorField &	U
	)		const

Return the frame acceleration.

Definition at line 195 of file MRFZoneList.C.

References MRFZoneList::DDt().

Here is the call graph for this function:

◆ makeRelative() [1/3]

void makeRelative ( volVectorField & U ) const

Make the given absolute velocity relative within the MRF region.

Definition at line 204 of file MRFZoneList.C.

References forAll, and UPtrList< T >::operator[]().

Referenced by MRFZoneList::relative().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ makeRelative() [2/3]

void makeRelative ( surfaceScalarField & phi ) const

Make the given absolute flux relative within the MRF region.

Definition at line 213 of file MRFZoneList.C.

References forAll, UPtrList< T >::operator[](), and MRFZoneList::relative().

Here is the call graph for this function:

◆ relative() [1/3]

Foam::tmp< Foam::surfaceScalarField > relative ( const tmp< surfaceScalarField > & phi ) const

Return the given absolute flux relative within the MRF region.

Definition at line 223 of file MRFZoneList.C.

References tmp< T >::clear(), MRFZoneList::makeRelative(), Foam::name(), Foam::New(), tmp< T >::ref(), and UPtrList< T >::size().

Referenced by MRFZoneList::correctBoundaryFlux(), MRFZoneList::makeRelative(), and MRFZoneList::relative().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ relative() [2/3]

Foam::tmp< Foam::FieldField< Foam::fvsPatchField, Foam::scalar > > relative ( const tmp< FieldField< fvsPatchField, scalar >> & tphi ) const

Return the given absolute boundary flux relative within.

the MRF region

Definition at line 255 of file MRFZoneList.C.

References tmp< T >::clear(), forAll, Foam::New(), UPtrList< T >::operator[](), tmp< T >::ref(), MRFZoneList::relative(), and UPtrList< T >::size().

Here is the call graph for this function:

◆ relative() [3/3]

Foam::tmp< Foam::Field< Foam::scalar > > relative	(	const tmp< Field< scalar >> &	tphi,
		const label	patchi
	)		const

Return the given absolute patch flux relative within.

the MRF region

Definition at line 281 of file MRFZoneList.C.

References tmp< T >::clear(), forAll, MRFZoneList::makeRelative(), Foam::New(), UPtrList< T >::operator[](), patchi, tmp< T >::ref(), and UPtrList< T >::size().

Here is the call graph for this function:

◆ makeRelative() [3/3]

void makeRelative	(	const surfaceScalarField &	rho,
		surfaceScalarField &	phi
	)		const

Make the given absolute mass-flux relative within the MRF region.

Definition at line 307 of file MRFZoneList.C.

References forAll, and UPtrList< T >::operator[]().

Here is the call graph for this function:

◆ makeAbsolute() [1/3]

void makeAbsolute ( volVectorField & U ) const

Make the given relative velocity absolute within the MRF region.

Definition at line 319 of file MRFZoneList.C.

References forAll, and UPtrList< T >::operator[]().

Referenced by MRFZoneList::absolute().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ makeAbsolute() [2/3]

void makeAbsolute ( surfaceScalarField & phi ) const

Make the given relative flux absolute within the MRF region.

Definition at line 328 of file MRFZoneList.C.

References MRFZoneList::absolute(), forAll, and UPtrList< T >::operator[]().

Here is the call graph for this function:

◆ absolute()

Foam::tmp< Foam::surfaceScalarField > absolute ( const tmp< surfaceScalarField > & phi ) const

Return the given relative flux absolute within the MRF region.

Definition at line 338 of file MRFZoneList.C.

References tmp< T >::clear(), MRFZoneList::makeAbsolute(), Foam::name(), Foam::New(), tmp< T >::ref(), and UPtrList< T >::size().

Referenced by MRFZoneList::makeAbsolute().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ makeAbsolute() [3/3]

void makeAbsolute	(	const surfaceScalarField &	rho,
		surfaceScalarField &	phi
	)		const

Make the given relative mass-flux absolute within the MRF region.

Definition at line 369 of file MRFZoneList.C.

References forAll, and UPtrList< T >::operator[]().

Here is the call graph for this function:

◆ correctBoundaryVelocity()

void correctBoundaryVelocity ( volVectorField & U ) const

Correct the boundary velocity for the rotation of the MRF region.

Definition at line 381 of file MRFZoneList.C.

References MRFZoneList::correctBoundaryFlux(), forAll, and UPtrList< T >::operator[]().

Here is the call graph for this function:

◆ correctBoundaryFlux()

void correctBoundaryFlux	(	const volVectorField &	U,
		surfaceScalarField &	phi
	)		const

Correct the boundary flux for the rotation of the MRF region.

Definition at line 391 of file MRFZoneList.C.

References fvMesh::boundary(), GeometricField< Type, PatchField, GeoMesh >::boundaryField(), GeometricField< Type, PatchField, GeoMesh >::boundaryFieldRef(), forAll, MRFZoneList::mesh_, patchi, MRFZoneList::relative(), fvMesh::Sf(), and Uf.

Referenced by MRFZoneList::correctBoundaryVelocity().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ read()

bool read ( const dictionary & dict )

Read dictionary.

Definition at line 104 of file MRFZoneList.C.

References forAll, MRFZone::name(), UPtrList< T >::operator[](), MRFZone::read(), and dictionary::subDict().

Referenced by IOMRFZoneList::read().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ writeData()

bool writeData ( Ostream & os ) const

Write data to Ostream.

Definition at line 117 of file MRFZoneList.C.

References MRFZoneList::addAcceleration(), forAll, IOstream::good(), Foam::nl, and UPtrList< T >::operator[]().

Here is the call graph for this function:

Friends And Related Function Documentation

◆ operator<<

Ostream& operator<<	(	Ostream &	os,
		const MRFZoneList &	models
	)

friend

Ostream operator.

Member Data Documentation

◆ mesh_

const fvMesh& mesh_

protected

Reference to the mesh database.

Definition at line 75 of file MRFZoneList.H.

Referenced by MRFZoneList::correctBoundaryFlux(), and MRFZoneList::reset().

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

src/finiteVolume/cfdTools/general/MRF/MRFZoneList.H
src/finiteVolume/cfdTools/general/MRF/MRFZoneList.C

Public Member Functions

Protected Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ MRFZoneList()

◆ ~MRFZoneList()

Member Function Documentation

◆ active()

◆ reset()

◆ addAcceleration() [1/3]

◆ addAcceleration() [2/3]

◆ addAcceleration() [3/3]

◆ DDt() [1/2]

◆ DDt() [2/2]

◆ makeRelative() [1/3]

◆ makeRelative() [2/3]

◆ relative() [1/3]

◆ relative() [2/3]

◆ relative() [3/3]

◆ makeRelative() [3/3]

◆ makeAbsolute() [1/3]

◆ makeAbsolute() [2/3]

◆ absolute()

◆ makeAbsolute() [3/3]

◆ correctBoundaryVelocity()

◆ correctBoundaryFlux()

◆ read()

◆ writeData()

Friends And Related Function Documentation

◆ operator<<

Member Data Documentation

◆ mesh_