Public Member Functions | List of all members
rotatingWallVelocityFvPatchVectorField Class Reference

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

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

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...
 
virtual tmp< fvPatchVectorField > clone () const
 Construct and return a clone. More...
 
 rotatingWallVelocityFvPatchVectorField (const rotatingWallVelocityFvPatchVectorField &, const DimensionedField< vector, volMesh > &)
 Construct as copy 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 vector & origin () const
 Return the origin of the rotation. More...
 
const vector & axis () const
 Return the axis of the rotation. More...
 
vector & origin ()
 Return non-const access to the origin of the rotation. More...
 
vector & axis ()
 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 co-ordinates 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 97 of file rotatingWallVelocityFvPatchVectorField.H.

Constructor & Destructor Documentation

Construct from patch and internal field.

Definition at line 35 of file rotatingWallVelocityFvPatchVectorField.C.

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

Here is the caller graph for this function:

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

Construct from patch, internal field and dictionary.

Definition at line 49 of file rotatingWallVelocityFvPatchVectorField.C.

References dictionary::found(), rotatingWallVelocityFvPatchVectorField::rotatingWallVelocityFvPatchVectorField(), List< Type >::size(), and vectorField().

Here is the call graph for this function:

Construct by mapping given rotatingWallVelocityFvPatchVectorField.

onto a new patch

Definition at line 77 of file rotatingWallVelocityFvPatchVectorField.C.

References rotatingWallVelocityFvPatchVectorField::rotatingWallVelocityFvPatchVectorField().

Here is the call graph for this function:

Construct as copy.

Definition at line 93 of file rotatingWallVelocityFvPatchVectorField.C.

References rotatingWallVelocityFvPatchVectorField::rotatingWallVelocityFvPatchVectorField().

Here is the call graph for this function:

Construct as copy setting internal field reference.

Definition at line 106 of file rotatingWallVelocityFvPatchVectorField.C.

Member Function Documentation

TypeName ( "rotatingWallVelocity"  )

Runtime type information.

virtual tmp<fvPatchVectorField> clone ( ) const
inlinevirtual

Construct and return a clone.

Definition at line 153 of file rotatingWallVelocityFvPatchVectorField.H.

References rotatingWallVelocityFvPatchVectorField::rotatingWallVelocityFvPatchVectorField().

Here is the call graph for this function:

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

Construct and return a clone setting internal field reference.

Definition at line 170 of file rotatingWallVelocityFvPatchVectorField.H.

References rotatingWallVelocityFvPatchVectorField::rotatingWallVelocityFvPatchVectorField().

Here is the call graph for this function:

const vector& origin ( ) const
inline

Return the origin of the rotation.

Definition at line 187 of file rotatingWallVelocityFvPatchVectorField.H.

const vector& axis ( ) const
inline

Return the axis of the rotation.

Definition at line 193 of file rotatingWallVelocityFvPatchVectorField.H.

vector& origin ( )
inline

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

Definition at line 199 of file rotatingWallVelocityFvPatchVectorField.H.

vector& axis ( )
inline

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

Definition at line 205 of file rotatingWallVelocityFvPatchVectorField.H.

References rotatingWallVelocityFvPatchVectorField::updateCoeffs(), and rotatingWallVelocityFvPatchVectorField::write().

Here is the call graph for this function:

void updateCoeffs ( )
virtual

Update the coefficients associated with the patch field.

Definition at line 120 of file rotatingWallVelocityFvPatchVectorField.C.

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

Referenced by rotatingWallVelocityFvPatchVectorField::axis().

Here is the call graph for this function:

Here is the caller graph for this function:

void write ( Ostream &  os) const
virtual

Write.

Definition at line 145 of file rotatingWallVelocityFvPatchVectorField.C.

References token::END_STATEMENT, Foam::makePatchTypeField(), Foam::nl, fvPatchField< Type >::write(), and Ostream::writeKeyword().

Referenced by rotatingWallVelocityFvPatchVectorField::axis().

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: