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)
 Construct from fvMesh. More...
 
 MRFZone (const MRFZone &)=delete
 Disallow default bitwise copy construction. More...
 
autoPtr< MRFZone > clone () const
 Return clone. More...
 
const word & name () const
 Return const access to the MRF region name. More...
 
vector Omega () const
 Return the current Omega vector. More...
 
void addCoriolis (const volVectorField &U, volVectorField &ddtU) const
 Add the Coriolis force contribution to the acceleration field. More...
 
void addCentrifugalAcceleration (volVectorField &centrifugalAcceleration) const
 Add 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...
 
void makeRelative (FieldField< fvsPatchField, scalar > &phi) const
 Make the given absolute boundary flux relative. More...
 
void makeRelative (Field< scalar > &phi, const label patchi) const
 Make the given absolute patch flux relative. More...
 
void makeRelative (const surfaceScalarField &rho, surfaceScalarField &phi) const
 Make the given absolute mass-flux relative within the MRF region. More...
 
void makeRelative (Field< vector > &Up, const label patchi) const
 Make the given relative patch velocity relative. 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 makeAbsolute (Field< vector > &Up, const label patchi) const
 Make the given relative patch velocity absolute. More...
 
template<class Type >
void zero (SurfaceField< Type > &phi) const
 Zero the MRF region of the given field. More...
 
void update ()
 Update MRFZone faces if the mesh topology changes. More...
 
bool read (const dictionary &dict)
 Read MRF dictionary. More...
 
void operator= (const MRFZone &)=delete
 Disallow default bitwise assignment. 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 55 of file MRFZone.H.

Constructor & Destructor Documentation

◆ MRFZone() [1/2]

MRFZone ( const word &  name,
const fvMesh &  mesh,
const dictionary &  dict 
)

Construct from fvMesh.

Definition at line 165 of file MRFZone.C.

References Foam::mag().

Here is the call graph for this function:

◆ MRFZone() [2/2]

MRFZone ( const MRFZone &  )
delete

Disallow default bitwise copy construction.

Member Function Documentation

◆ ClassName()

ClassName ( "MRFZone"  )

◆ clone()

autoPtr<MRFZone> clone ( ) const
inline

Return clone.

Definition at line 149 of file MRFZone.H.

References NotImplemented.

◆ name()

const Foam::word & name ( ) const
inline

Return const access to the MRF region name.

Definition at line 26 of file MRFZoneI.H.

Referenced by MRFZoneList::read().

Here is the caller graph for this function:

◆ Omega()

Foam::vector Omega ( ) const

Return the current Omega vector.

Definition at line 187 of file MRFZone.C.

◆ addCoriolis()

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

Add the Coriolis force contribution to the acceleration field.

Definition at line 193 of file MRFZone.C.

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

Here is the call graph for this function:

◆ addCentrifugalAcceleration()

void addCentrifugalAcceleration ( volVectorField &  centrifugalAcceleration) const

Add the centrifugal acceleration.

Definition at line 215 of file MRFZone.C.

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

Here is the call graph for this function:

◆ makeRelative() [1/6]

void makeRelative ( volVectorField &  U) const

Make the given absolute velocity relative within the MRF region.

Definition at line 247 of file MRFZone.C.

References C::C(), cells, forAll, patchi, and U.

Here is the call graph for this function:

◆ makeRelative() [2/6]

void makeRelative ( surfaceScalarField &  phi) const

Make the given absolute flux relative within the MRF region.

Definition at line 275 of file MRFZone.C.

◆ makeRelative() [3/6]

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

Make the given absolute boundary flux relative.

within the MRF region

Definition at line 281 of file MRFZone.C.

◆ makeRelative() [4/6]

void makeRelative ( Field< scalar > &  phi,
const label  patchi 
) const

Make the given absolute patch flux relative.

within the MRF region

Definition at line 287 of file MRFZone.C.

References patchi.

◆ makeRelative() [5/6]

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

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

Definition at line 293 of file MRFZone.C.

References rho.

◆ makeRelative() [6/6]

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

Make the given relative patch velocity relative.

within the MRF region

Definition at line 303 of file MRFZone.C.

References patchi.

◆ makeAbsolute() [1/4]

void makeAbsolute ( volVectorField &  U) const

Make the given relative velocity absolute within the MRF region.

Definition at line 311 of file MRFZone.C.

References C::C(), cells, forAll, patchi, and U.

Here is the call graph for this function:

◆ makeAbsolute() [2/4]

void makeAbsolute ( surfaceScalarField &  phi) const

Make the given relative flux absolute within the MRF region.

Definition at line 338 of file MRFZone.C.

◆ 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 344 of file MRFZone.C.

References rho.

◆ makeAbsolute() [4/4]

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

Make the given relative patch velocity absolute.

within the MRF region

Definition at line 354 of file MRFZone.C.

References patchi.

◆ zero()

void zero ( SurfaceField< Type > &  phi) const

Zero the MRF region of the given field.

Definition at line 160 of file MRFZoneTemplates.C.

References GeometricField< Type, PatchField, GeoMesh >::boundaryFieldRef(), forAll, patchi, GeometricField< Type, PatchField, GeoMesh >::primitiveFieldRef(), and Foam::Zero.

Here is the call graph for this function:

◆ update()

void update ( )

Update MRFZone faces if the mesh topology changes.

Definition at line 372 of file MRFZone.C.

◆ read()

bool read ( const dictionary &  dict)

Read MRF dictionary.

Definition at line 362 of file MRFZone.C.

References dict, and dictionary::read().

Referenced by MRFZoneList::read().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ operator=()

void operator= ( const MRFZone &  )
delete

Disallow default bitwise assignment.

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