Public Member Functions | List of all members
MRFZone Class Reference

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

Public Member Functions

 ClassName ("MRFZone")
 
 MRFZone (const word &name, const fvMesh &mesh, const dictionary &dict, const word &cellZoneName=word::null)
 Construct from fvMesh. More...
 
autoPtr< MRFZoneclone () const
 Return clone. More...
 
const wordname () const
 Return const access to the MRF region name. More...
 
bool active () const
 Return const access to the MRF active flag. More...
 
vector Omega () const
 Return the current Omega vector. More...
 
void updateMesh (const mapPolyMesh &mpm)
 Update the mesh corresponding to given map. More...
 
void addCoriolis (const volVectorField &U, volVectorField &ddtU) const
 Add the Coriolis force contribution to the acceleration field. More...
 
void addCoriolis (fvVectorMatrix &UEqn, const bool rhs=false) const
 Add the Coriolis force contribution to the momentum equation. More...
 
void addCoriolis (const volScalarField &rho, fvVectorMatrix &UEqn, const bool rhs=false) const
 Add the Coriolis force contribution to the momentum equation. 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...
 
void makeRelative (FieldField< fvsPatchField, scalar > &phi) const
 Make the given absolute boundary flux relative. 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...
 
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 writeData (Ostream &os) const
 Write. More...
 
bool read (const dictionary &dict)
 Read MRF dictionary. More...
 

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

Definition at line 65 of file MRFZone.H.

Constructor & Destructor Documentation

MRFZone ( const word name,
const fvMesh mesh,
const dictionary dict,
const word cellZoneName = word::null 
)

Construct from fvMesh.

Definition at line 237 of file MRFZone.C.

References Foam::exit(), Foam::FatalError, FatalErrorIn, forAllConstIter(), Foam::mag(), word::null, and Foam::reduce().

Here is the call graph for this function:

Member Function Documentation

ClassName ( "MRFZone"  )
autoPtr<MRFZone> clone ( ) const
inline

Return clone.

Definition at line 164 of file MRFZone.H.

References MRFZone::active(), MRFZone::name(), notImplemented, and MRFZone::Omega().

Here is the call graph for this function:

const Foam::word & name ( ) const
inline

Return const access to the MRF region name.

Definition at line 26 of file MRFZoneI.H.

Referenced by MRFZone::clone(), and MRFZoneList::read().

Here is the caller graph for this function:

bool active ( ) const
inline

Return const access to the MRF active flag.

Definition at line 32 of file MRFZoneI.H.

Referenced by MRFZoneList::active(), and MRFZone::clone().

Here is the caller graph for this function:

Foam::vector Omega ( ) const

Return the current Omega vector.

Definition at line 313 of file MRFZone.C.

References MRFZone::addCoriolis().

Referenced by MRFZone::clone().

Here is the call graph for this function:

Here is the caller graph for this function:

void updateMesh ( const mapPolyMesh mpm)
inline

Update the mesh corresponding to given map.

Definition at line 188 of file MRFZone.H.

References MRFZone::addCoriolis(), MRFZone::correctBoundaryVelocity(), MRFZone::makeAbsolute(), MRFZone::makeRelative(), MRFZone::read(), U, UEqn(), and MRFZone::writeData().

Here is the call graph for this function:

void addCoriolis ( const volVectorField U,
volVectorField ddtU 
) const

Add the Coriolis force contribution to the acceleration field.

Definition at line 320 of file MRFZone.C.

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

Referenced by MRFZoneList::addAcceleration(), MRFZone::addCoriolis(), MRFZoneList::DDt(), MRFZone::Omega(), and MRFZone::updateMesh().

Here is the call graph for this function:

Here is the caller graph for this function:

void addCoriolis ( fvVectorMatrix UEqn,
const bool  rhs = false 
) const

Add the Coriolis force contribution to the momentum equation.

Adds to the lhs of the equation; optionally add to rhs

Definition at line 344 of file MRFZone.C.

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

Here is the call graph for this function:

void addCoriolis ( const volScalarField rho,
fvVectorMatrix UEqn,
const bool  rhs = false 
) const

Add the Coriolis force contribution to the momentum equation.

Adds to the lhs of the equation; optionally add to rhs

Definition at line 378 of file MRFZone.C.

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

Here is the call graph for this function:

void makeRelative ( volVectorField U) const

Make the given absolute velocity relative within the MRF region.

Definition at line 415 of file MRFZone.C.

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

Referenced by MRFZoneList::makeRelative(), MRFZone::makeRelative(), MRFZoneList::relative(), and MRFZone::updateMesh().

Here is the call graph for this function:

Here is the caller graph for this function:

void makeRelative ( surfaceScalarField phi) const

Make the given absolute flux relative within the MRF region.

Definition at line 453 of file MRFZone.C.

void makeRelative ( FieldField< fvsPatchField, scalar > &  phi) const

Make the given absolute boundary flux relative.

within the MRF region

Definition at line 459 of file MRFZone.C.

References MRFZone::makeRelative().

Here is the call graph for this function:

void makeRelative ( const surfaceScalarField rho,
surfaceScalarField phi 
) const

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

Definition at line 466 of file MRFZone.C.

void makeAbsolute ( volVectorField U) const

Make the given relative velocity absolute within the MRF region.

Definition at line 475 of file MRFZone.C.

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

Referenced by MRFZoneList::makeAbsolute(), MRFZone::makeAbsolute(), and MRFZone::updateMesh().

Here is the call graph for this function:

Here is the caller graph for this function:

void makeAbsolute ( surfaceScalarField phi) const

Make the given relative flux absolute within the MRF region.

Definition at line 513 of file MRFZone.C.

References MRFZone::makeAbsolute().

Here is the call graph for this function:

void makeAbsolute ( const surfaceScalarField rho,
surfaceScalarField phi 
) const

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

Definition at line 520 of file MRFZone.C.

void correctBoundaryVelocity ( volVectorField U) const

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

Definition at line 529 of file MRFZone.C.

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

Referenced by MRFZoneList::correctBoundaryVelocity(), and MRFZone::updateMesh().

Here is the call graph for this function:

Here is the caller graph for this function:

void writeData ( Ostream os) const

Write.

Definition at line 552 of file MRFZone.C.

References token::BEGIN_BLOCK, Foam::decrIndent(), token::END_BLOCK, token::END_STATEMENT, Foam::incrIndent(), Foam::nl, Ostream::write(), and Ostream::writeKeyword().

Referenced by MRFZone::updateMesh(), and MRFZoneList::writeData().

Here is the call graph for this function:

Here is the caller graph for this function:

bool read ( const dictionary dict)

Read MRF dictionary.

Definition at line 573 of file MRFZone.C.

References dict, and dictionary::lookupOrDefault().

Referenced by MRFZoneList::read(), and MRFZone::updateMesh().

Here is the call graph for this function:

Here is the caller graph for this function:


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