Public Member Functions | List of all members
SRFVelocityFvPatchVectorField Class Reference

Velocity condition to be used in conjunction with the single rotating frame (SRF) model (see: SRFModel class) More...

Inheritance diagram for SRFVelocityFvPatchVectorField:
Inheritance graph
[legend]
Collaboration diagram for SRFVelocityFvPatchVectorField:
Collaboration graph
[legend]

Public Member Functions

 TypeName ("SRFVelocity")
 
 SRFVelocityFvPatchVectorField (const fvPatch &, const DimensionedField< vector, volMesh > &)
 
 SRFVelocityFvPatchVectorField (const fvPatch &, const DimensionedField< vector, volMesh > &, const dictionary &)
 
 SRFVelocityFvPatchVectorField (const SRFVelocityFvPatchVectorField &, const fvPatch &, const DimensionedField< vector, volMesh > &, const fvPatchFieldMapper &)
 
 SRFVelocityFvPatchVectorField (const SRFVelocityFvPatchVectorField &)
 
virtual tmp< fvPatchVectorFieldclone () const
 
 SRFVelocityFvPatchVectorField (const SRFVelocityFvPatchVectorField &, const DimensionedField< vector, volMesh > &)
 
virtual tmp< fvPatchVectorFieldclone (const DimensionedField< vector, volMesh > &iF) const
 
bool relative () const
 
virtual void autoMap (const fvPatchFieldMapper &)
 
virtual void rmap (const fvPatchVectorField &, const labelList &)
 
virtual void updateCoeffs ()
 
virtual void write (Ostream &) const
 

Detailed Description

Velocity condition to be used in conjunction with the single rotating frame (SRF) model (see: SRFModel class)

Given the free stream velocity in the absolute frame, the condition applies the appropriate rotation transformation in time and space to determine the local velocity.

The optional relative flag switches the behaviour of the patch such that:

\[ U_p = U_{in} \]

\[ U_p = U_{in} - U_{p,srf} \]

where

$ U_p $ = patch velocity [m/s]
$ U_{in} $ = user-specified inlet velocity
$ U_{p,srf} $ = SRF velocity
Usage
Property Description Required Default value
inletValue inlet velocity yes
relative inletValue relative motion to the SRF? yes

Example of the boundary condition specification:

    <patchName>
    {
        type            SRFVelocity;
        inletValue      uniform (0 0 0);
        relative        yes;
        value           uniform (0 0 0);    // initial value
    }
See also
Foam::fixedValueFvPatchField
Source files

Definition at line 127 of file SRFVelocityFvPatchVectorField.H.

Constructor & Destructor Documentation

◆ SRFVelocityFvPatchVectorField() [1/5]

Definition at line 30 of file SRFVelocityFvPatchVectorField.C.

Referenced by SRFVelocityFvPatchVectorField::clone().

Here is the caller graph for this function:

◆ SRFVelocityFvPatchVectorField() [2/5]

SRFVelocityFvPatchVectorField ( const fvPatch p,
const DimensionedField< vector, volMesh > &  iF,
const dictionary dict 
)

Definition at line 56 of file SRFVelocityFvPatchVectorField.C.

◆ SRFVelocityFvPatchVectorField() [3/5]

SRFVelocityFvPatchVectorField ( const SRFVelocityFvPatchVectorField ptf,
const fvPatch p,
const DimensionedField< vector, volMesh > &  iF,
const fvPatchFieldMapper mapper 
)

Definition at line 42 of file SRFVelocityFvPatchVectorField.C.

◆ SRFVelocityFvPatchVectorField() [4/5]

Definition at line 69 of file SRFVelocityFvPatchVectorField.C.

◆ SRFVelocityFvPatchVectorField() [5/5]

Definition at line 80 of file SRFVelocityFvPatchVectorField.C.

Member Function Documentation

◆ TypeName()

TypeName ( "SRFVelocity"  )

◆ clone() [1/2]

virtual tmp<fvPatchVectorField> clone ( ) const
inlinevirtual

Definition at line 180 of file SRFVelocityFvPatchVectorField.H.

References SRFVelocityFvPatchVectorField::SRFVelocityFvPatchVectorField().

Here is the call graph for this function:

◆ clone() [2/2]

virtual tmp<fvPatchVectorField> clone ( const DimensionedField< vector, volMesh > &  iF) const
inlinevirtual

Definition at line 197 of file SRFVelocityFvPatchVectorField.H.

References SRFVelocityFvPatchVectorField::SRFVelocityFvPatchVectorField().

Here is the call graph for this function:

◆ relative()

bool relative ( ) const
inline

Definition at line 213 of file SRFVelocityFvPatchVectorField.H.

Referenced by SRFModel::Uabs().

Here is the caller graph for this function:

◆ autoMap()

void autoMap ( const fvPatchFieldMapper m)
virtual

Definition at line 94 of file SRFVelocityFvPatchVectorField.C.

◆ rmap()

void rmap ( const fvPatchVectorField ptf,
const labelList addr 
)
virtual

Definition at line 104 of file SRFVelocityFvPatchVectorField.C.

◆ updateCoeffs()

void updateCoeffs ( )
virtual

Definition at line 118 of file SRFVelocityFvPatchVectorField.C.

References Foam::operator==(), Foam::foamVersion::patch, and SRFModel::velocity().

Here is the call graph for this function:

◆ write()

void write ( Ostream os) const
virtual

Definition at line 148 of file SRFVelocityFvPatchVectorField.C.

References os(), fvPatchField::write(), and Ostream::writeEntry().

Here is the call graph for this function:

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