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")
 Runtime type information. More...
 
 SRFVelocityFvPatchVectorField (const fvPatch &, const DimensionedField< vector, volMesh > &)
 Construct from patch and internal field. More...
 
 SRFVelocityFvPatchVectorField (const fvPatch &, const DimensionedField< vector, volMesh > &, const dictionary &)
 Construct from patch, internal field and dictionary. More...
 
 SRFVelocityFvPatchVectorField (const SRFVelocityFvPatchVectorField &, const fvPatch &, const DimensionedField< vector, volMesh > &, const fvPatchFieldMapper &)
 Construct by mapping given SRFVelocityFvPatchVectorField. More...
 
 SRFVelocityFvPatchVectorField (const SRFVelocityFvPatchVectorField &)=delete
 Disallow copy without setting internal field reference. More...
 
 SRFVelocityFvPatchVectorField (const SRFVelocityFvPatchVectorField &, const DimensionedField< vector, volMesh > &)
 Copy constructor setting internal field reference. More...
 
virtual tmp< fvPatchVectorField > clone (const DimensionedField< vector, volMesh > &iF) const
 Construct and return a clone setting internal field reference. More...
 
const Switch & relative () const
 Return const access to the relative flag. More...
 
virtual void autoMap (const fvPatchFieldMapper &)
 Map (and resize as needed) from self given a mapping object. More...
 
virtual void rmap (const fvPatchVectorField &, const labelList &)
 Reverse map the given fvPatchField onto this fvPatchField. More...
 
virtual void reset (const fvPatchVectorField &)
 Reset the fvPatchField to the given fvPatchField. More...
 
virtual void updateCoeffs ()
 Update the coefficients associated with the patch field. More...
 
virtual void write (Ostream &) const
 Write. More...
 

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:

  • relative = yes: inlet velocity applied 'as is':

\[ U_p = U_{in} \]

  • relative = no : SRF velocity is subtracted from the inlet velocity:

\[ 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 123 of file SRFVelocityFvPatchVectorField.H.

Constructor & Destructor Documentation

◆ SRFVelocityFvPatchVectorField() [1/5]

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

Construct from patch and internal field.

Definition at line 35 of file SRFVelocityFvPatchVectorField.C.

Referenced by SRFVelocityFvPatchVectorField::clone(), and SRFVelocityFvPatchVectorField::SRFVelocityFvPatchVectorField().

Here is the caller graph for this function:

◆ SRFVelocityFvPatchVectorField() [2/5]

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

Construct from patch, internal field and dictionary.

Definition at line 47 of file SRFVelocityFvPatchVectorField.C.

References SRFVelocityFvPatchVectorField::SRFVelocityFvPatchVectorField().

Here is the call graph for this function:

◆ SRFVelocityFvPatchVectorField() [3/5]

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

Construct by mapping given SRFVelocityFvPatchVectorField.

onto a new patch

Definition at line 60 of file SRFVelocityFvPatchVectorField.C.

References SRFVelocityFvPatchVectorField::SRFVelocityFvPatchVectorField().

Here is the call graph for this function:

◆ SRFVelocityFvPatchVectorField() [4/5]

SRFVelocityFvPatchVectorField ( const SRFVelocityFvPatchVectorField &  )
delete

Disallow copy without setting internal field reference.

◆ SRFVelocityFvPatchVectorField() [5/5]

SRFVelocityFvPatchVectorField ( const SRFVelocityFvPatchVectorField &  srfvpvf,
const DimensionedField< vector, volMesh > &  iF 
)

Copy constructor setting internal field reference.

Definition at line 74 of file SRFVelocityFvPatchVectorField.C.

References SRFVelocityFvPatchVectorField::autoMap().

Here is the call graph for this function:

Member Function Documentation

◆ TypeName()

TypeName ( "SRFVelocity"  )

Runtime type information.

◆ clone()

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

Construct and return a clone setting internal field reference.

Definition at line 184 of file SRFVelocityFvPatchVectorField.H.

References SRFVelocityFvPatchVectorField::SRFVelocityFvPatchVectorField().

Here is the call graph for this function:

◆ relative()

const Switch& relative ( ) const
inline

Return const access to the relative flag.

Definition at line 200 of file SRFVelocityFvPatchVectorField.H.

References SRFVelocityFvPatchVectorField::autoMap(), SRFVelocityFvPatchVectorField::reset(), SRFVelocityFvPatchVectorField::rmap(), SRFVelocityFvPatchVectorField::updateCoeffs(), and SRFVelocityFvPatchVectorField::write().

Referenced by SRFModel::Uabs().

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

◆ autoMap()

void autoMap ( const fvPatchFieldMapper &  m)
virtual

Map (and resize as needed) from self given a mapping object.

Used to update fields following mesh topology change

Definition at line 88 of file SRFVelocityFvPatchVectorField.C.

References SRFVelocityFvPatchVectorField::rmap().

Referenced by SRFVelocityFvPatchVectorField::relative(), and SRFVelocityFvPatchVectorField::SRFVelocityFvPatchVectorField().

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

◆ rmap()

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

Reverse map the given fvPatchField onto this fvPatchField.

Used to reconstruct fields

Definition at line 98 of file SRFVelocityFvPatchVectorField.C.

References SRFVelocityFvPatchVectorField::reset(), and SRFVelocityFvPatchVectorField::rmap().

Referenced by SRFVelocityFvPatchVectorField::autoMap(), SRFVelocityFvPatchVectorField::relative(), and SRFVelocityFvPatchVectorField::rmap().

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

◆ reset()

void reset ( const fvPatchVectorField &  ptf)
virtual

Reset the fvPatchField to the given fvPatchField.

Used for mesh to mesh mapping

Definition at line 113 of file SRFVelocityFvPatchVectorField.C.

References SRFVelocityFvPatchVectorField::reset().

Referenced by SRFVelocityFvPatchVectorField::relative(), SRFVelocityFvPatchVectorField::reset(), and SRFVelocityFvPatchVectorField::rmap().

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

◆ updateCoeffs()

void updateCoeffs ( )
virtual

Update the coefficients associated with the patch field.

Definition at line 126 of file SRFVelocityFvPatchVectorField.C.

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

Referenced by SRFVelocityFvPatchVectorField::relative().

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

◆ write()

void write ( Ostream &  os) const
virtual

Write.

Definition at line 156 of file SRFVelocityFvPatchVectorField.C.

References Foam::makePatchTypeField(), fvPatchField< Type >::write(), and Foam::writeEntry().

Referenced by SRFVelocityFvPatchVectorField::relative().

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: