List container for MRF zones. More...

Inheritance diagram for MRFZoneList:

Collaboration diagram for MRFZoneList:

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

	MRFZoneList (const MRFZoneList &)=delete
	Disallow default bitwise copy construction. More...

	~MRFZoneList ()
	Destructor. More...

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

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

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

tmp< volVectorField >	centrifugalAcceleration () const
	Return the centrifugal 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< surfaceMesh::PatchField, scalar > >	relative (const tmp< FieldField< surfaceMesh::PatchField, scalar >> &) 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...

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

void	makeAbsolute (Field< vector > &Up, const label patchi) const

void	update ()
	Update MRFZone faces if the mesh topology changes. More...

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

void	operator= (const MRFZoneList &)=delete
	Disallow default bitwise assignment. More...

Public Member Functions inherited from PtrList< MRFZone >
	PtrList ()
	Null Constructor. More...

	PtrList (const label)
	Construct with size specified. More...

	PtrList (const PtrList< MRFZone > &)
	Copy constructor. More...

	PtrList (const PtrList< MRFZone > &, const CloneArg &)
	Copy constructor with additional argument for clone. More...

	PtrList (PtrList< MRFZone > &&)
	Move constructor. More...

	PtrList (PtrList< MRFZone > &, bool reuse)
	Construct as copy or reuse as specified. More...

	PtrList (const SLPtrList< MRFZone > &)
	Construct as copy of SLPtrList<T> More...

	PtrList (Istream &, const INew &)
	Construct from Istream using given Istream constructor class. More...

	PtrList (Istream &)
	Construct from Istream using default Istream constructor class. More...

	~PtrList ()
	Destructor. More...

void	setSize (const label)
	Reset size of PtrList. If extending the PtrList, new entries are. More...

void	resize (const label)
	Alias for setSize(const label) More...

void	shrink ()
	Shrink the allocated space to the number of elements used. More...

void	clear ()
	Clear the PtrList, i.e. set size to zero deleting all the. More...

void	append (MRFZone *)
	Append an element at the end of the list. More...

void	append (const autoPtr< MRFZone > &)
	Append an element at the end of the list. More...

void	append (const tmp< MRFZone > &)
	Append an element at the end of the list. More...

void	transfer (PtrList< MRFZone > &)
	Transfer the contents of the argument PtrList into this PtrList. More...

bool	set (const label) const
	Is element set. More...

autoPtr< MRFZone >	set (const label, MRFZone *)
	Set element to given T* and return old element (can be nullptr) More...

autoPtr< MRFZone >	set (const label, const autoPtr< MRFZone > &)
	Set element to given autoPtr<T> and return old element. More...

autoPtr< MRFZone >	set (const label, const tmp< MRFZone > &)
	Set element to given tmp<T> and return old element. More...

void	reorder (const labelUList &oldToNew)
	Reorders elements. Ordering does not have to be done in. More...

void	shuffle (const labelUList &newToOld)
	Reorders elements. Ordering does not have to be done in. More...

void	operator= (const PtrList< MRFZone > &)
	Assignment operator. More...

void	operator= (PtrList< MRFZone > &&)
	Move assignment operator. More...

Public Member Functions inherited from UPtrList< T >
	UPtrList ()
	Null Constructor. More...

	UPtrList (const label)
	Construct with size specified. More...

	UPtrList (UPtrList< T > &, bool reuse)
	Construct as copy or reuse as specified. More...

	UPtrList (std::initializer_list< T * >)
	Construct from an initialiser list of pointers. More...

label	size () const
	Return the number of elements in the UPtrList. More...

bool	empty () const
	Return true if the UPtrList is empty (ie, size() is zero) More...

T &	first ()
	Return reference to the first element of the list. More...

const T &	first () const
	Return reference to first element of the list. More...

T &	last ()
	Return reference to the last element of the list. More...

const T &	last () const
	Return reference to the last element of the list. More...

void	setSize (const label)
	Reset size of UPtrList. This can only be used to set the size. More...

void	resize (const label)
	Reset size of UPtrList. This can only be used to set the size. More...

void	clear ()
	Clear the UPtrList, i.e. set size to zero. More...

void	append (T *)
	Append an element at the end of the list. More...

void	transfer (UPtrList< T > &)
	Transfer the contents of the argument UPtrList into this. More...

bool	set (const label) const
	Is element set. More...

T *	set (const label, T *)
	Set element. Return old element (can be nullptr). More...

void	reorder (const labelUList &oldToNew)
	Reorders elements. Ordering does not have to be done in. More...

void	shuffle (const labelUList &newToOld)
	Reorders elements. Ordering does not have to be done in. More...

template<class T2 >
UPtrList< T2 >	convert ()
	Convert to list of different pointer type. More...

template<class T2 >
UPtrList< const T2 >	convert () const
	Convert to list of different pointer type. More...

const T &	operator[] (const label) const
	Return element const reference. More...

T &	operator[] (const label)
	Return element reference. More...

const T *	operator() (const label) const
	Return element const pointer. More...

T *	operator() (const label)
	Return element const pointer. More...

iterator	begin ()
	Return an iterator to begin traversing the UPtrList. More...

iterator	end ()
	Return an iterator to end traversing the UPtrList. More...

const_iterator	cbegin () const
	Return an const_iterator to begin traversing the UPtrList. More...

const_iterator	cend () const
	Return an const_iterator to end traversing the UPtrList. More...

const_iterator	begin () const
	Return an const_iterator to begin traversing the UPtrList. More...

const_iterator	end () const
	Return an const_iterator to end traversing the UPtrList. More...

template<class T2 >
Foam::UPtrList< T2 >	convert ()

template<class T2 >
Foam::UPtrList< const T2 >	convert () const

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

Additional Inherited Members
Public Types inherited from UPtrList< T >
typedef T	value_type
	Type of values the UPtrList contains. More...

typedef T &	reference
	Type that can be used for storing into UPtrList::value_type objects. More...

typedef const T &	const_reference
	Type that can be used for storing into constant UPtrList::value_type. More...

Protected Member Functions inherited from PtrList< MRFZone >
void	read (Istream &, const INew &inewt)
	Read from Istream using given Istream constructor class. More...

Detailed Description

List container for MRF zones.

Source files

Definition at line 55 of file MRFZoneList.H.

Constructor & Destructor Documentation

◆ MRFZoneList() [1/2]

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

Definition at line 32 of file MRFZoneList.C.

References dict, and MRFZoneList::reset().

Here is the call graph for this function:

◆ MRFZoneList() [2/2]

MRFZoneList ( const MRFZoneList & )

delete

Disallow default bitwise copy construction.

◆ ~MRFZoneList()

~MRFZoneList ( )

Destructor.

Definition at line 47 of file MRFZoneList.C.

Member Function Documentation

◆ reset()

void reset ( const dictionary & dict )

Reset the source list.

Definition at line 53 of file MRFZoneList.C.

References Foam::count(), dict, Foam::endl(), forAllConstIter, Foam::Info, Foam::name(), and setSize().

Referenced by MRFZoneList::MRFZoneList().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ DDt() [1/2]

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

Return the Coriolis acceleration.

Definition at line 98 of file MRFZoneList.C.

References Foam::fvc::DDt(), Foam::dimTime, forAll, GeometricField< Type, GeoMesh, PrimitiveField >::New(), tmp< T >::ref(), U, and Foam::Zero.

Referenced by incompressibleFluid::momentumPredictor(), isothermalFluid::momentumPredictor(), and VoFSolver::momentumPredictor().

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 Coriolis acceleration.

Definition at line 123 of file MRFZoneList.C.

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

Here is the call graph for this function:

◆ centrifugalAcceleration()

Foam::tmp< Foam::volVectorField > centrifugalAcceleration ( ) const

Return the centrifugal acceleration.

Definition at line 134 of file MRFZoneList.C.

References Foam::dimAcceleration, forAll, GeometricField< Type, GeoMesh, PrimitiveField >::New(), tmp< T >::ref(), and Foam::Zero.

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 157 of file MRFZoneList.C.

References forAll, and U.

Referenced by incompressibleFluid::correctPressure(), twoPhaseSolver::incompressiblePressureCorrector(), compressibleMultiphaseVoF::pressureCorrector(), compressibleVoF::pressureCorrector(), and incompressibleMultiphaseVoF::pressureCorrector().

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 166 of file MRFZoneList.C.

References forAll.

◆ 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 175 of file MRFZoneList.C.

References tmp< T >::clear(), Foam::dimensions(), Foam::fvc::makeRelative(), Foam::name(), Foam::New(), and tmp< T >::ref().

Here is the call graph for this function:

◆ relative() [2/3]

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

Return the given absolute boundary flux relative within.

the MRF region

Definition at line 207 of file MRFZoneList.C.

References forAll, Foam::New(), and tmp< T >::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

Return the given absolute patch flux relative within.

the MRF region

Definition at line 233 of file MRFZoneList.C.

References forAll, Foam::New(), patchi, and tmp< T >::ref().

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 259 of file MRFZoneList.C.

References forAll, and rho.

◆ makeAbsolute() [1/4]

void makeAbsolute ( volVectorField & U ) const

Make the given relative velocity absolute within the MRF region.

Definition at line 272 of file MRFZoneList.C.

References forAll, and U.

◆ makeAbsolute() [2/4]

void makeAbsolute ( surfaceScalarField & phi ) const

Make the given relative flux absolute within the MRF region.

Definition at line 281 of file MRFZoneList.C.

References forAll.

◆ absolute() [1/2]

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

Return the given relative flux absolute within the MRF region.

Definition at line 290 of file MRFZoneList.C.

References tmp< T >::clear(), Foam::dimensions(), Foam::fvc::makeAbsolute(), Foam::name(), Foam::New(), and tmp< T >::ref().

Here is the call graph for this function:

◆ makeAbsolute() [3/4]

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

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

Definition at line 321 of file MRFZoneList.C.

References forAll, and rho.

◆ absolute() [2/2]

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

Return the given relative flux absolute within the MRF region.

Definition at line 334 of file MRFZoneList.C.

References tmp< T >::clear(), Foam::dimensions(), Foam::fvc::interpolate(), Foam::fvc::makeAbsolute(), Foam::name(), Foam::New(), tmp< T >::ref(), and rho.

Here is the call graph for this function:

◆ makeAbsolute() [4/4]

void makeAbsolute	(	Field< vector > &	Up,
		const label	patchi
	)		const

◆ update()

void update ( )

Update MRFZone faces if the mesh topology changes.

Definition at line 366 of file MRFZoneList.C.

References forAll.

◆ read()

bool read ( const dictionary & dict )

Read dictionary.

Definition at line 85 of file MRFZoneList.C.

References dict, forAll, MRFZone::name(), 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:

◆ operator=()

void operator= ( const MRFZoneList & )

delete

Disallow default bitwise assignment.

Member Data Documentation

◆ mesh_

const fvMesh& mesh_

protected

Reference to the mesh database.

Definition at line 64 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

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ MRFZoneList() [1/2]

◆ MRFZoneList() [2/2]

◆ ~MRFZoneList()

Member Function Documentation

◆ reset()

◆ DDt() [1/2]

◆ DDt() [2/2]

◆ centrifugalAcceleration()

◆ makeRelative() [1/3]

◆ makeRelative() [2/3]

◆ relative() [1/3]

◆ relative() [2/3]

◆ relative() [3/3]

◆ makeRelative() [3/3]

◆ makeAbsolute() [1/4]

◆ makeAbsolute() [2/4]

◆ absolute() [1/2]

◆ makeAbsolute() [3/4]

◆ absolute() [2/2]

◆ makeAbsolute() [4/4]

◆ update()

◆ read()

◆ operator=()

Member Data Documentation

◆ mesh_