MRFZone Class Reference

MRF zone definition based on cell zone and parameters obtained from a control dictionary constructed from the given stream. More...

#include <finiteVolume/MRFZone.H>

---

Detailed Description

MRF zone definition based on cell zone and parameters obtained from a control dictionary constructed from the given stream.

The rotation of the MRF region is defined by an origin and axis of rotation and an angular speed.

Source files

• src/finiteVolume/cfdTools/general/MRF/MRFZone.H
• src/finiteVolume/cfdTools/general/MRF/MRFZone.C

Definition at line 64 of file MRFZone.H.

Collaboration diagram for MRFZone:

List of all members.

Classes
class	iNew
	Return a pointer to a new MRFZone created on freestore. More...
Public Member Functions
	ClassName ("MRFZone")
	MRFZone (const fvMesh &mesh, Istream &is)
	Construct from fvMesh and Istream.
autoPtr< MRFZone >	clone () const
	Return clone.
void	updateMesh (const mapPolyMesh &mpm)
	Update the mesh corresponding to given map.
void	addCoriolis (fvVectorMatrix &UEqn) const
	Add the Coriolis force contribution to the momentum equation.
void	addCoriolis (const volScalarField &rho, fvVectorMatrix &UEqn) const
	Add the Coriolis force contribution to the momentum equation.
void	relativeVelocity (volVectorField &U) const
	Make the given absolute velocity relative within the MRF region.
void	absoluteVelocity (volVectorField &U) const
	Make the given relative velocity absolute within the MRF region.
void	relativeFlux (surfaceScalarField &phi) const
	Make the given absolute flux relative within the MRF region.
void	relativeFlux (const surfaceScalarField &rho, surfaceScalarField &phi) const
	Make the given absolute mass-flux relative within the MRF region.
void	absoluteFlux (surfaceScalarField &phi) const
	Make the given relative flux absolute within the MRF region.
void	absoluteFlux (const surfaceScalarField &rho, surfaceScalarField &phi) const
	Make the given relative mass-flux absolute within the MRF region.
void	correctBoundaryVelocity (volVectorField &U) const
	Correct the boundary velocity for the roation of the MRF region.
Friends
Ostream &	operator<< (Ostream &os, const MRFZone &)

---

Constructor & Destructor Documentation

MRFZone	(	const fvMesh &	mesh,
		Istream &	is
	)

Construct from fvMesh and Istream.

Definition at line 230 of file MRFZone.C.

References polyMesh::boundaryMesh(), Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorIn, polyBoundaryMesh::findPatchID(), forAll, dictionary::found(), Foam::mag(), Foam::reduce(), List< T >::setSize(), List< T >::size(), and WarningIn.

---

Member Function Documentation

ClassName

(

"MRFZone"

)

autoPtr<MRFZone> clone

(

)

const [inline]

Return clone.

Definition at line 134 of file MRFZone.H.

References notImplemented.

void updateMesh

(

const mapPolyMesh &

mpm  )

[inline]

Update the mesh corresponding to given map.

Definition at line 163 of file MRFZone.H.

void addCoriolis

(

fvVectorMatrix &

UEqn  )

const

Add the Coriolis force contribution to the momentum equation.

Definition at line 294 of file MRFZone.C.

References cells, forAll, fvMatrix< Type >::psi(), fvMatrix< Type >::source(), and U.

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

Add the Coriolis force contribution to the momentum equation.

Definition at line 316 of file MRFZone.C.

References cells, forAll, fvMatrix< Type >::psi(), fvMatrix< Type >::source(), and U.

void relativeVelocity

(

volVectorField &

U  )

const

Make the given absolute velocity relative within the MRF region.

Definition at line 340 of file MRFZone.C.

References GeometricField< Type, PatchField, GeoMesh >::boundaryField(), C::C(), cells, forAll, and Vector< Cmpt >::zero.

void absoluteVelocity

(

volVectorField &

U  )

const

Make the given relative velocity absolute within the MRF region.

Definition at line 378 of file MRFZone.C.

References GeometricField< Type, PatchField, GeoMesh >::boundaryField(), C::C(), cells, and forAll.

void relativeFlux

(

surfaceScalarField &

phi  )

const

Make the given absolute flux relative within the MRF region.

Definition at line 417 of file MRFZone.C.

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

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

Definition at line 424 of file MRFZone.C.

void absoluteFlux

(

surfaceScalarField &

phi  )

const

Make the given relative flux absolute within the MRF region.

Definition at line 433 of file MRFZone.C.

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

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

Definition at line 440 of file MRFZone.C.

void correctBoundaryVelocity

(

volVectorField &

U  )

const

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

Definition at line 449 of file MRFZone.C.

References GeometricField< Type, PatchField, GeoMesh >::boundaryField(), and forAll.

---

Friends And Related Function Documentation

Ostream& operator<<	(	Ostream &	os,
		const MRFZone &
	)		[friend]

Definition at line 207 of file MRFZone.H.

---

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

• src/finiteVolume/cfdTools/general/MRF/MRFZone.H
• src/finiteVolume/cfdTools/general/MRF/MRFZone.C
• src/finiteVolume/cfdTools/general/MRF/MRFZoneTemplates.C