List container for MRF zomes. More...

Inheritance diagram for MRFZoneList:

Collaboration diagram for MRFZoneList:

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

	~MRFZoneList ()=default

bool	active (const bool warn=false) const

void	reset (const dictionary &dict)

const MRFZone &	getFromName (const word &name) const

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

void	addAcceleration (fvVectorMatrix &UEqn) const

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

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

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

void	makeRelative (volVectorField &U) const

void	makeRelative (surfaceScalarField &phi) const

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

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

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

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

void	makeAbsolute (volVectorField &U) const

void	makeAbsolute (surfaceScalarField &phi) const

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

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

void	correctBoundaryVelocity (volVectorField &U) const

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

template<class Type >
tmp< GeometricField< Type, fvsPatchField, surfaceMesh > >	zeroFilter (const tmp< GeometricField< Type, fvsPatchField, surfaceMesh >> &tphi) const

void	update ()

bool	read (const dictionary &dict)

bool	writeData (Ostream &os) const

template<class Type >
Foam::tmp< Foam::GeometricField< Type, Foam::fvsPatchField, Foam::surfaceMesh > >	zeroFilter (const tmp< GeometricField< Type, fvsPatchField, surfaceMesh >> &tphi) const

Public Member Functions inherited from PtrList< MRFZone >
constexpr	PtrList () noexcept

	PtrList (const label len)

	PtrList (const PtrList< T > &list)

	PtrList (PtrList< T > &&list)

	PtrList (UList< T * > &list)

	PtrList (const PtrList< T > &list, const CloneArg &cloneArgs)

	PtrList (PtrList< T > &list, bool reuse)

	PtrList (const SLPtrList< T > &list)

	PtrList (Istream &is, const INew &inew)

	PtrList (Istream &is)

	PtrList (PtrList< T > &list, bool reuse)

	PtrList (const SLPtrList< T > &list)

constexpr	PtrList () noexcept

	PtrList (const label len)

	PtrList (const PtrList< T > &list)

	PtrList (PtrList< T > &&list)

	PtrList (UList< T * > &list)

	PtrList (Istream &is)

	~PtrList ()

PtrList< T >	clone (Args &&... args) const

Foam::PtrList< T >	clone (Args &&... args) const

const T *	set (const label i) const

autoPtr< T >	set (const label i, T *ptr)

autoPtr< T >	set (const label i, autoPtr< T > &ptr)

autoPtr< T >	set (const label i, autoPtr< T > &&ptr)

autoPtr< T >	set (const label i, std::unique_ptr< T > &&ptr)

autoPtr< T >	set (const label i, const refPtr< T > &ptr)

autoPtr< T >	set (const label i, const tmp< T > &ptr)

void	clear ()

void	resize (const label newLen)

void	setSize (const label newLen)

void	emplace_append (Args &&... args)

void	append (T *ptr)

void	append (autoPtr< T > &ptr)

void	append (autoPtr< T > &&ptr)

void	append (std::unique_ptr< T > &&ptr)

void	append (const refPtr< T > &ptr)

void	append (const tmp< T > &ptr)

autoPtr< T >	emplace (const label i, Args &&... args)

Foam::autoPtr< T >	emplace (const label i, Args &&... args)

autoPtr< T >	release (const label i)

void	transfer (PtrList< T > &list)

void	operator= (const PtrList< T > &list)

void	operator= (PtrList< T > &&list)

Protected Attributes
const fvMesh &	mesh_

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

Additional Inherited Members
Protected Member Functions inherited from PtrList< MRFZone >
void	readIstream (Istream &is, const INew &inew)

void	free ()

Detailed Description

List container for MRF zomes.

Source files

Definition at line 54 of file MRFZoneList.H.

Constructor & Destructor Documentation

◆ MRFZoneList()

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

Definition at line 29 of file MRFZoneList.C.

References dict, and reset().

Here is the call graph for this function:

◆ ~MRFZoneList()

~MRFZoneList ( )

default

Member Function Documentation

◆ active()

bool active ( const bool warn = false ) const

Definition at line 45 of file MRFZoneList.C.

References Foam::endl(), forAll, and Foam::Info.

Here is the call graph for this function:

◆ reset()

void reset ( const dictionary & dict )

Definition at line 62 of file MRFZoneList.C.

References Foam::BitOps::count(), dict, Foam::endl(), Foam::Info, Foam::name(), resize(), and Foam::BitOps::set().

Here is the call graph for this function:

◆ getFromName()

const Foam::MRFZone & getFromName ( const word & name ) const

Definition at line 96 of file MRFZoneList.C.

References List::append(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, Foam::name(), and Foam::PtrListOps::names().

Here is the call graph for this function:

◆ addAcceleration() [1/3]

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

Definition at line 145 of file MRFZoneList.C.

References U.

◆ addAcceleration() [2/3]

void addAcceleration ( fvVectorMatrix & UEqn ) const

Definition at line 157 of file MRFZoneList.C.

References UEqn.

◆ addAcceleration() [3/3]

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

Definition at line 167 of file MRFZoneList.C.

References rho, and UEqn.

◆ DDt() [1/2]

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

Definition at line 180 of file MRFZoneList.C.

References Foam::dimTime, tmp::New(), U, and Foam::Zero.

Here is the call graph for this function:

◆ DDt() [2/2]

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

Definition at line 208 of file MRFZoneList.C.

References Foam::fvc::DDt(), rho, and U.

Here is the call graph for this function:

◆ makeRelative() [1/3]

void makeRelative ( volVectorField & U ) const

Definition at line 217 of file MRFZoneList.C.

References U.

◆ makeRelative() [2/3]

void makeRelative ( surfaceScalarField & phi ) const

Definition at line 226 of file MRFZoneList.C.

References phi.

◆ relative() [1/3]

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

Definition at line 236 of file MRFZoneList.C.

References tmp::clear(), Foam::fvc::makeRelative(), Foam::name(), Foam::New(), and tmp::ref().

Here is the call graph for this function:

◆ relative() [2/3]

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

Definition at line 268 of file MRFZoneList.C.

References tmp::clear(), Foam::New(), and tmp::ref().

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

Definition at line 294 of file MRFZoneList.C.

References tmp::clear(), Foam::New(), and tmp::ref().

Here is the call graph for this function:

◆ makeRelative() [3/3]

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

Definition at line 320 of file MRFZoneList.C.

References phi, and rho.

◆ makeAbsolute() [1/3]

void makeAbsolute ( volVectorField & U ) const

Definition at line 332 of file MRFZoneList.C.

References U.

◆ makeAbsolute() [2/3]

void makeAbsolute ( surfaceScalarField & phi ) const

Definition at line 341 of file MRFZoneList.C.

References phi.

◆ absolute()

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

Definition at line 351 of file MRFZoneList.C.

References tmp::clear(), Foam::fvc::makeAbsolute(), Foam::name(), Foam::New(), and tmp::ref().

Here is the call graph for this function:

◆ makeAbsolute() [3/3]

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

Definition at line 382 of file MRFZoneList.C.

References phi, and rho.

◆ correctBoundaryVelocity()

void correctBoundaryVelocity ( volVectorField & U ) const

Definition at line 394 of file MRFZoneList.C.

References U.

◆ correctBoundaryFlux()

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

Definition at line 404 of file MRFZoneList.C.

References GeometricField::boundaryFieldRef(), forAll, phi, Foam::fvc::relative(), U, and Uf.

Here is the call graph for this function:

◆ zeroFilter() [1/2]

tmp<GeometricField<Type, fvsPatchField, surfaceMesh> > zeroFilter ( const tmp< GeometricField< Type, fvsPatchField, surfaceMesh >> & tphi ) const

◆ update()

void update ( )

Definition at line 426 of file MRFZoneList.C.

◆ read()

bool read ( const dictionary & dict )

Definition at line 120 of file MRFZoneList.C.

References dict, 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

Definition at line 132 of file MRFZoneList.C.

References IOstream::good(), Foam::nl, and os().

Here is the call graph for this function:

◆ zeroFilter() [2/2]

Foam::tmp<Foam::GeometricField<Type, Foam::fvsPatchField, Foam::surfaceMesh> > zeroFilter ( const tmp< GeometricField< Type, fvsPatchField, surfaceMesh >> & tphi ) const

Definition at line 28 of file MRFZoneListTemplates.C.

References forAll, Foam::name(), Foam::New(), and tmp::ref().

Here is the call graph for this function:

Friends And Related Function Documentation

◆ operator<<

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

friend

Member Data Documentation

◆ mesh_

const fvMesh& mesh_

protected

Definition at line 72 of file MRFZoneList.H.

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
src/finiteVolume/cfdTools/general/MRF/MRFZoneListTemplates.C

Public Member Functions

Protected Attributes

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ MRFZoneList()

◆ ~MRFZoneList()

Member Function Documentation

◆ active()

◆ reset()

◆ getFromName()

◆ 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()

◆ zeroFilter() [1/2]

◆ update()

◆ read()

◆ writeData()

◆ zeroFilter() [2/2]

Friends And Related Function Documentation

◆ operator<<

Member Data Documentation

◆ mesh_