rotatingWallVelocityFvPatchVectorField Class Reference

This boundary condition provides a rotational velocity condition. More...

Inheritance diagram for rotatingWallVelocityFvPatchVectorField:
Collaboration diagram for rotatingWallVelocityFvPatchVectorField:

Public Member Functions

 TypeName ("rotatingWallVelocity")
 Runtime type information. More...
 
 rotatingWallVelocityFvPatchVectorField (const fvPatch &, const DimensionedField< vector, volMesh > &)
 Construct from patch and internal field. More...
 
 rotatingWallVelocityFvPatchVectorField (const fvPatch &, const DimensionedField< vector, volMesh > &, const dictionary &)
 Construct from patch, internal field and dictionary. More...
 
 rotatingWallVelocityFvPatchVectorField (const rotatingWallVelocityFvPatchVectorField &, const fvPatch &, const DimensionedField< vector, volMesh > &, const fvPatchFieldMapper &)
 Construct by mapping given rotatingWallVelocityFvPatchVectorField. More...
 
 rotatingWallVelocityFvPatchVectorField (const rotatingWallVelocityFvPatchVectorField &)
 Construct as copy. More...
 
 rotatingWallVelocityFvPatchVectorField (const rotatingWallVelocityFvPatchVectorField &, const DimensionedField< vector, volMesh > &)
 Construct as copy setting internal field reference. More...
 
virtual tmp< fvPatchField< vector > > clone () const
 Return a clone. More...
 
virtual tmp< fvPatchField< vector > > clone (const DimensionedField< vector, volMesh > &iF) const
 Clone with an internal field reference. More...
 
const vectororigin () const
 Return the origin of the rotation. More...
 
const vectoraxis () const
 Return the axis of the rotation. More...
 
vectororigin ()
 Return non-const access to the origin of the rotation. More...
 
vectoraxis ()
 Return non-const access to the axis of the rotation. More...
 
virtual void updateCoeffs ()
 Update the coefficients associated with the patch field. More...
 
virtual void write (Ostream &) const
 Write. More...
 

Detailed Description

This boundary condition provides a rotational velocity condition.

Usage
Property Description Required Default value
origin origin of rotation in Cartesian coordinates yes
axis axis of rotation yes
omega angular velocty of the frame [rad/s] yes

Example of the boundary condition specification:

    <patchName>
    {
        type            rotatingWallVelocity;
        origin          (0 0 0);
        axis            (0 0 1);
        omega           100;
    }

The omega entry is a Function1 of time, see Foam::Function1Types.

See also
Foam::fixedValueFvPatchField Foam::Function1Types
Source files

Definition at line 95 of file rotatingWallVelocityFvPatchVectorField.H.

Constructor & Destructor Documentation

◆ rotatingWallVelocityFvPatchVectorField() [1/5]

Construct from patch and internal field.

Definition at line 31 of file rotatingWallVelocityFvPatchVectorField.C.

◆ rotatingWallVelocityFvPatchVectorField() [2/5]

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

Construct from patch, internal field and dictionary.

Definition at line 45 of file rotatingWallVelocityFvPatchVectorField.C.

References dict.

◆ rotatingWallVelocityFvPatchVectorField() [3/5]

Construct by mapping given rotatingWallVelocityFvPatchVectorField.

onto a new patch

Definition at line 66 of file rotatingWallVelocityFvPatchVectorField.C.

◆ rotatingWallVelocityFvPatchVectorField() [4/5]

◆ rotatingWallVelocityFvPatchVectorField() [5/5]

Construct as copy setting internal field reference.

Definition at line 95 of file rotatingWallVelocityFvPatchVectorField.C.

Member Function Documentation

◆ TypeName()

TypeName ( "rotatingWallVelocity"  )

Runtime type information.

◆ clone() [1/2]

virtual tmp<fvPatchField<vector> > clone ( ) const
inlinevirtual

Return a clone.

Definition at line 179 of file rotatingWallVelocityFvPatchVectorField.H.

References fvPatchField< Type >::Clone().

Here is the call graph for this function:

◆ clone() [2/2]

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

Clone with an internal field reference.

Definition at line 188 of file rotatingWallVelocityFvPatchVectorField.H.

References fvPatchField< Type >::Clone().

Here is the call graph for this function:

◆ origin() [1/2]

const vector& origin ( ) const
inline

Return the origin of the rotation.

Definition at line 203 of file rotatingWallVelocityFvPatchVectorField.H.

◆ axis() [1/2]

const vector& axis ( ) const
inline

Return the axis of the rotation.

Definition at line 211 of file rotatingWallVelocityFvPatchVectorField.H.

◆ origin() [2/2]

vector& origin ( )
inline

Return non-const access to the origin of the rotation.

Definition at line 219 of file rotatingWallVelocityFvPatchVectorField.H.

◆ axis() [2/2]

vector& axis ( )
inline

Return non-const access to the axis of the rotation.

Definition at line 227 of file rotatingWallVelocityFvPatchVectorField.H.

◆ updateCoeffs()

void updateCoeffs ( )
virtual

Update the coefficients associated with the patch field.

Definition at line 109 of file rotatingWallVelocityFvPatchVectorField.C.

References Foam::mag(), n, om, Field< vector >::operator=(), and Foam::foamVersion::patch.

Here is the call graph for this function:

◆ write()

void write ( Ostream os) const
virtual

Write.

Definition at line 134 of file rotatingWallVelocityFvPatchVectorField.C.

References os(), fvPatchField< Type >::write(), Ostream::writeEntry(), and fvPatchField< Type >::writeValueEntry().

Here is the call graph for this function:

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