Loading...
Searching...
No Matches
swirlInletVelocityFvPatchVectorField Class Reference
Boundary conditions » Inlet

This boundary condition describes an inlet vector boundary condition in swirl coordinates given a central axis, central point, axial, radial and tangential velocity profiles. More...

#include <swirlInletVelocityFvPatchVectorField.H>

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

Public Member Functions

 TypeName ("swirlInletVelocity")
 Runtime type information.
 swirlInletVelocityFvPatchVectorField (const fvPatch &, const DimensionedField< vector, volMesh > &)
 Construct from patch and internal field.
 swirlInletVelocityFvPatchVectorField (const fvPatch &, const DimensionedField< vector, volMesh > &, const dictionary &)
 Construct from patch, internal field and dictionary.
 swirlInletVelocityFvPatchVectorField (const swirlInletVelocityFvPatchVectorField &, const fvPatch &, const DimensionedField< vector, volMesh > &, const fvPatchFieldMapper &)
 Construct by mapping given.
 swirlInletVelocityFvPatchVectorField (const swirlInletVelocityFvPatchVectorField &)
 Construct as copy.
 swirlInletVelocityFvPatchVectorField (const swirlInletVelocityFvPatchVectorField &, const DimensionedField< vector, volMesh > &)
 Construct as copy setting internal field reference.
virtual tmp< fvPatchField< vector > > clone () const
 Return a clone.
virtual tmp< fvPatchField< vector > > clone (const DimensionedField< vector, volMesh > &iF) const
 Clone with an internal field reference.
virtual void updateCoeffs ()
 Update the coefficients associated with the patch field.
virtual void write (Ostream &) const
 Write.

Detailed Description

This boundary condition describes an inlet vector boundary condition in swirl coordinates given a central axis, central point, axial, radial and tangential velocity profiles.

Usage
Property Description Required Default value
axis Axis of rotation yes
origin Origin of rotation yes
axialVelocity Axial velocity profile [m/s] yes
radialVelocity Radial velocity profile [m/s] yes
tangentialVelocity tangential velocity profile [m/s] yes

Example of the boundary condition specification: 

    <patchName>
    {
        type            swirlInletVelocity;
        axis            (0 0 1);
        origin          (0 0 0);
        axialVelocity   constant 30;
        radialVelocity  constant 10;
        tangentialVelocity  constant 100;
    }
Note
The axialVelocity, radialVelocity and tangentialVelocity entries are Function1 types, able to describe time varying functions. The example above gives the usage for supplying constant values.
See also
Foam::fixedValueFvPatchField Foam::Function1Types
Source files

Definition at line 113 of file swirlInletVelocityFvPatchVectorField.H.

Constructor & Destructor Documentation

◆ swirlInletVelocityFvPatchVectorField() [1/5]

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

Construct from patch and internal field.

Definition at line 27 of file swirlInletVelocityFvPatchVectorField.C.

References p, and Foam::Zero.

Referenced by swirlInletVelocityFvPatchVectorField(), swirlInletVelocityFvPatchVectorField(), swirlInletVelocityFvPatchVectorField(), and TypeName().

Here is the caller graph for this function:

◆ swirlInletVelocityFvPatchVectorField() [2/5]

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

Construct from patch, internal field and dictionary.

Definition at line 61 of file swirlInletVelocityFvPatchVectorField.C.

References dict, Foam::New(), and p.

Here is the call graph for this function:

◆ swirlInletVelocityFvPatchVectorField() [3/5]

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

Construct by mapping given.

flowRateInletVelocityFvPatchVectorField onto a new patch

Definition at line 43 of file swirlInletVelocityFvPatchVectorField.C.

References clone(), p, and swirlInletVelocityFvPatchVectorField().

Here is the call graph for this function:

◆ swirlInletVelocityFvPatchVectorField() [4/5]

swirlInletVelocityFvPatchVectorField ( const swirlInletVelocityFvPatchVectorField & ptf)

Construct as copy.

Definition at line 84 of file swirlInletVelocityFvPatchVectorField.C.

References clone(), and swirlInletVelocityFvPatchVectorField().

Here is the call graph for this function:

◆ swirlInletVelocityFvPatchVectorField() [5/5]

swirlInletVelocityFvPatchVectorField ( const swirlInletVelocityFvPatchVectorField & ptf,
const DimensionedField< vector, volMesh > & iF )

Construct as copy setting internal field reference.

Definition at line 99 of file swirlInletVelocityFvPatchVectorField.C.

References clone(), and swirlInletVelocityFvPatchVectorField().

Here is the call graph for this function:

Member Function Documentation

◆ TypeName()

TypeName ( "swirlInletVelocity" )

Runtime type information.

References swirlInletVelocityFvPatchVectorField().

Here is the call graph for this function:

◆ clone() [1/2]

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

Return a clone.

Definition at line 208 of file swirlInletVelocityFvPatchVectorField.H.

References fvPatchField< Type >::Clone().

Referenced by swirlInletVelocityFvPatchVectorField(), swirlInletVelocityFvPatchVectorField(), and swirlInletVelocityFvPatchVectorField().

Here is the call graph for this function:
Here is the caller 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 216 of file swirlInletVelocityFvPatchVectorField.H.

References fvPatchField< Type >::Clone().

Here is the call graph for this function:

◆ updateCoeffs()

void updateCoeffs ( )
virtual

Update the coefficients associated with the patch field.

Definition at line 117 of file swirlInletVelocityFvPatchVectorField.C.

References Foam::mag(), and fvPatchField< Type >::updateCoeffs().

Here is the call graph for this function:

◆ write()

void write ( Ostream & os) const
virtual

Write.

Definition at line 147 of file swirlInletVelocityFvPatchVectorField.C.

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

Here is the call graph for this function:
The documentation for this class was generated from the following files: