Public Member Functions | List of all members
swirlInletVelocityFvPatchVectorField Class Reference

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

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

Public Member Functions

 TypeName ("swirlInletVelocity")
 Runtime type information. More...
 
 swirlInletVelocityFvPatchVectorField (const fvPatch &, const DimensionedField< vector, volMesh > &)
 Construct from patch and internal field. More...
 
 swirlInletVelocityFvPatchVectorField (const fvPatch &, const DimensionedField< vector, volMesh > &, const dictionary &)
 Construct from patch, internal field and dictionary. More...
 
 swirlInletVelocityFvPatchVectorField (const swirlInletVelocityFvPatchVectorField &, const fvPatch &, const DimensionedField< vector, volMesh > &, const fvPatchFieldMapper &)
 Construct by mapping given. More...
 
 swirlInletVelocityFvPatchVectorField (const swirlInletVelocityFvPatchVectorField &)=delete
 Disallow copy without setting internal field reference. More...
 
 swirlInletVelocityFvPatchVectorField (const swirlInletVelocityFvPatchVectorField &, 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...
 
virtual void updateCoeffs ()
 Update the coefficients associated with the patch field. More...
 
virtual void write (Ostream &) const
 Write. More...
 

Detailed Description

This boundary condition describes an inlet vector boundary condition in swirl co-ordinates 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::Function1s
Source files

Definition at line 112 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 33 of file swirlInletVelocityFvPatchVectorField.C.

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

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 49 of file swirlInletVelocityFvPatchVectorField.C.

References swirlInletVelocityFvPatchVectorField::swirlInletVelocityFvPatchVectorField().

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 66 of file swirlInletVelocityFvPatchVectorField.C.

References swirlInletVelocityFvPatchVectorField::swirlInletVelocityFvPatchVectorField().

Here is the call graph for this function:

◆ swirlInletVelocityFvPatchVectorField() [4/5]

swirlInletVelocityFvPatchVectorField ( const swirlInletVelocityFvPatchVectorField &  )
delete

Disallow copy without setting internal field reference.

◆ swirlInletVelocityFvPatchVectorField() [5/5]

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

Copy constructor setting internal field reference.

Definition at line 84 of file swirlInletVelocityFvPatchVectorField.C.

Member Function Documentation

◆ TypeName()

TypeName ( "swirlInletVelocity"  )

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 183 of file swirlInletVelocityFvPatchVectorField.H.

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

Here is the call graph for this function:

◆ updateCoeffs()

void updateCoeffs ( )
virtual

Update the coefficients associated with the patch field.

Definition at line 100 of file swirlInletVelocityFvPatchVectorField.C.

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

Referenced by swirlInletVelocityFvPatchVectorField::clone().

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 130 of file swirlInletVelocityFvPatchVectorField.C.

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

Referenced by swirlInletVelocityFvPatchVectorField::clone().

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: