Public Member Functions | List of all members
swirlFlowRateInletVelocityFvPatchVectorField Class Reference

This boundary condition provides a volumetric- OR mass-flow normal vector boundary condition by its magnitude as an integral over its area with a swirl component determined by the angular speed, given in revolutions per minute (RPM) More...

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

Public Member Functions

 TypeName ("swirlFlowRateInletVelocity")
 Runtime type information. More...
 
 swirlFlowRateInletVelocityFvPatchVectorField (const fvPatch &, const DimensionedField< vector, volMesh > &)
 Construct from patch and internal field. More...
 
 swirlFlowRateInletVelocityFvPatchVectorField (const fvPatch &, const DimensionedField< vector, volMesh > &, const dictionary &)
 Construct from patch, internal field and dictionary. More...
 
 swirlFlowRateInletVelocityFvPatchVectorField (const swirlFlowRateInletVelocityFvPatchVectorField &, const fvPatch &, const DimensionedField< vector, volMesh > &, const fvPatchFieldMapper &)
 Construct by mapping given. More...
 
 swirlFlowRateInletVelocityFvPatchVectorField (const swirlFlowRateInletVelocityFvPatchVectorField &)=delete
 Disallow copy without setting internal field reference. More...
 
 swirlFlowRateInletVelocityFvPatchVectorField (const swirlFlowRateInletVelocityFvPatchVectorField &, 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 provides a volumetric- OR mass-flow normal vector boundary condition by its magnitude as an integral over its area with a swirl component determined by the angular speed, given in revolutions per minute (RPM)

The basis of the patch (volumetric or mass) is determined by the dimensions of the flux, phi. The current density is used to correct the velocity when applying the mass basis.

Usage
Property Description Required Default value
phi flux field name no phi
rho density field name no rho
origin origin of rotation no patch centre
axis axis of rotation no -patch normal
flowRate flow rate profile yes
rpm rotational speed profile yes

Example of the boundary condition specification: 

    <patchName>
    {
        type            swirlFlowRateInletVelocity;
        flowRate        constant 0.2;
        rpm             constant 100;
    }
Note
  • the flowRate and rpm entries are Function1 types, able to describe time varying functions. The example above gives the usage for supplying constant values.
  • the value is positive into the domain
See also
Foam::fixedValueFvPatchField Foam::Function1s
Source files

Definition at line 121 of file swirlFlowRateInletVelocityFvPatchVectorField.H.

Constructor & Destructor Documentation

◆ swirlFlowRateInletVelocityFvPatchVectorField() [1/5]

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

Construct from patch and internal field.

Definition at line 37 of file swirlFlowRateInletVelocityFvPatchVectorField.C.

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

Here is the caller graph for this function:

◆ swirlFlowRateInletVelocityFvPatchVectorField() [2/5]

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

Construct from patch, internal field and dictionary.

Definition at line 54 of file swirlFlowRateInletVelocityFvPatchVectorField.C.

References swirlFlowRateInletVelocityFvPatchVectorField::swirlFlowRateInletVelocityFvPatchVectorField().

Here is the call graph for this function:

◆ swirlFlowRateInletVelocityFvPatchVectorField() [3/5]

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

Construct by mapping given.

flowRateInletVelocityFvPatchVectorField onto a new patch

Definition at line 90 of file swirlFlowRateInletVelocityFvPatchVectorField.C.

References swirlFlowRateInletVelocityFvPatchVectorField::swirlFlowRateInletVelocityFvPatchVectorField().

Here is the call graph for this function:

◆ swirlFlowRateInletVelocityFvPatchVectorField() [4/5]

swirlFlowRateInletVelocityFvPatchVectorField ( const swirlFlowRateInletVelocityFvPatchVectorField &  )
delete

Disallow copy without setting internal field reference.

◆ swirlFlowRateInletVelocityFvPatchVectorField() [5/5]

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

Copy constructor setting internal field reference.

Definition at line 109 of file swirlFlowRateInletVelocityFvPatchVectorField.C.

Member Function Documentation

◆ TypeName()

TypeName ( "swirlFlowRateInletVelocity"  )

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 195 of file swirlFlowRateInletVelocityFvPatchVectorField.H.

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

Here is the call graph for this function:

◆ updateCoeffs()

void updateCoeffs ( )
virtual

Update the coefficients associated with the patch field.

Definition at line 126 of file swirlFlowRateInletVelocityFvPatchVectorField.C.

References DimensionedField< Type, GeoMesh >::dimensions(), Foam::dimFlux, Foam::dimMassFlux, Foam::exit(), Foam::FatalError, FatalErrorInFunction, Foam::gSum(), Foam::mag(), n, Foam::nl, Foam::operator==(), phi, Foam::constant::mathematical::pi(), fvPatchField< Type >::updateCoeffs(), Function1< Type >::value(), and swirlFlowRateInletVelocityFvPatchVectorField::write().

Referenced by swirlFlowRateInletVelocityFvPatchVectorField::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 181 of file swirlFlowRateInletVelocityFvPatchVectorField.C.

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

Referenced by swirlFlowRateInletVelocityFvPatchVectorField::clone(), and swirlFlowRateInletVelocityFvPatchVectorField::updateCoeffs().

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: