swirlFanVelocityFvPatchField Class Reference

This boundary condition provides a jump condition for U across a cyclic pressure jump condition and applies a transformation to U. More...

Inheritance diagram for swirlFanVelocityFvPatchField:
[legend]
Collaboration diagram for swirlFanVelocityFvPatchField:
[legend]

Public Member Functions

 TypeName ("swirlFanVelocity")
 Runtime type information. More...
 
 swirlFanVelocityFvPatchField (const fvPatch &, const DimensionedField< vector, volMesh > &)
 Construct from patch and internal field. More...
 
 swirlFanVelocityFvPatchField (const fvPatch &, const DimensionedField< vector, volMesh > &, const dictionary &)
 Construct from patch, internal field and dictionary. More...
 
 swirlFanVelocityFvPatchField (const swirlFanVelocityFvPatchField &, const fvPatch &, const DimensionedField< vector, volMesh > &, const fvPatchFieldMapper &)
 
 swirlFanVelocityFvPatchField (const swirlFanVelocityFvPatchField &)
 Construct as copy. More...
 
virtual tmp< fvPatchField< vector > > clone () const
 Construct and return a clone. More...
 
 swirlFanVelocityFvPatchField (const swirlFanVelocityFvPatchField &, const DimensionedField< vector, volMesh > &)
 Construct as copy setting internal field reference. More...
 
virtual tmp< fvPatchField< vector > > 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 &os) const
 Write. More...
 
- Public Member Functions inherited from fixedJumpFvPatchField< vector >
 TypeName ("fixedJump")
 Runtime type information. More...
 
 fixedJumpFvPatchField (const fvPatch &, const DimensionedField< vector, volMesh > &)
 Construct from patch and internal field. More...
 
 fixedJumpFvPatchField (const fvPatch &, const DimensionedField< vector, volMesh > &, const dictionary &, const bool valueRequired=true)
 Construct from patch, internal field and dictionary. More...
 
 fixedJumpFvPatchField (const fixedJumpFvPatchField< vector > &, const fvPatch &, const DimensionedField< vector, volMesh > &, const fvPatchFieldMapper &)
 Construct by mapping given fixedJumpFvPatchField onto a. More...
 
 fixedJumpFvPatchField (const fixedJumpFvPatchField< vector > &)
 Construct as copy. More...
 
 fixedJumpFvPatchField (const fixedJumpFvPatchField< vector > &, const DimensionedField< vector, volMesh > &)
 Construct as copy setting internal field reference. More...
 
virtual void setJump (const Field< vector > &jump)
 Set the jump field. More...
 
virtual void setJump (const vector &jump)
 Set the jump field (uniform value) More...
 
virtual tmp< Field< vector > > jump () const
 Return the "jump" across the patch. More...
 
virtual tmp< Field< vector > > jump0 () const
 Return the old time "jump" across the patch. More...
 
virtual scalar relaxFactor () const
 Return the under-relaxation factor. More...
 
virtual void relax ()
 Return the relaxed "jump" across the patch. More...
 
virtual void autoMap (const fvPatchFieldMapper &)
 Map (and resize as needed) from self given a mapping object. More...
 
virtual void rmap (const fvPatchField< vector > &, const labelList &)
 Reverse map the given fvPatchField onto this fvPatchField. More...
 
- Public Member Functions inherited from jumpCyclicFvPatchField< vector >
 TypeName ("jumpCyclic")
 Runtime type information. More...
 
 jumpCyclicFvPatchField (const fvPatch &, const DimensionedField< vector, volMesh > &)
 Construct from patch and internal field. More...
 
 jumpCyclicFvPatchField (const fvPatch &, const DimensionedField< vector, volMesh > &, const dictionary &, const bool valueRequired=true)
 Construct from patch, internal field and dictionary. More...
 
 jumpCyclicFvPatchField (const jumpCyclicFvPatchField< vector > &, const fvPatch &, const DimensionedField< vector, volMesh > &, const fvPatchFieldMapper &)
 Construct by mapping given jumpCyclicFvPatchField onto a new patch. More...
 
 jumpCyclicFvPatchField (const jumpCyclicFvPatchField< vector > &)
 Construct as copy. More...
 
 jumpCyclicFvPatchField (const jumpCyclicFvPatchField< vector > &, const DimensionedField< vector, volMesh > &)
 Construct as copy setting internal field reference. More...
 
virtual const wordinterfaceFieldType () const
 Return the interface type. More...
 
tmp< Field< vector > > patchNeighbourField () const
 Return neighbour coupled given internal cell data. More...
 
virtual void updateInterfaceMatrix (solveScalarField &result, const bool add, const lduAddressing &lduAddr, const label patchId, const solveScalarField &psiInternal, const scalarField &coeffs, const direction cmpt, const Pstream::commsTypes commsType) const
 Update result field based on interface functionality. More...
 
virtual void updateInterfaceMatrix (Field< vector > &, const bool add, const lduAddressing &lduAddr, const label patchId, const Field< vector > &, const scalarField &, const Pstream::commsTypes commsType) const
 Update result field based on interface functionality. More...
 
void updateInterfaceMatrix (solveScalarField &result, const bool add, const lduAddressing &lduAddr, const label patchId, const solveScalarField &psiInternal, const scalarField &coeffs, const direction cmpt, const Pstream::commsTypes commsType) const
 Update result field based on interface functionality. More...
 
void updateInterfaceMatrix (solveScalarField &result, const bool add, const lduAddressing &lduAddr, const label patchId, const solveScalarField &psiInternal, const scalarField &coeffs, const direction cmpt, const Pstream::commsTypes commsType) const
 Update result field based on interface functionality. More...
 
void updateInterfaceMatrix (solveScalarField &result, const bool add, const lduAddressing &lduAddr, const label patchId, const solveScalarField &psiInternal, const scalarField &coeffs, const direction cmpt, const Pstream::commsTypes) const
 Update result field based on interface functionality. More...
 
void updateInterfaceMatrix (solveScalarField &result, const bool add, const lduAddressing &lduAddr, const label patchId, const solveScalarField &psiInternal, const scalarField &coeffs, const direction cmpt, const Pstream::commsTypes) const
 Update result field based on interface functionality. More...
 
- Public Member Functions inherited from cyclicFvPatchField< vector >
 TypeName (cyclicFvPatch::typeName_())
 Runtime type information. More...
 
 cyclicFvPatchField (const fvPatch &, const DimensionedField< vector, volMesh > &)
 Construct from patch and internal field. More...
 
 cyclicFvPatchField (const fvPatch &, const DimensionedField< vector, volMesh > &, const dictionary &, const bool valueRequired=true)
 Construct from patch, internal field and dictionary. More...
 
 cyclicFvPatchField (const cyclicFvPatchField< vector > &, const fvPatch &, const DimensionedField< vector, volMesh > &, const fvPatchFieldMapper &)
 Construct by mapping given cyclicFvPatchField onto a new patch. More...
 
 cyclicFvPatchField (const cyclicFvPatchField< vector > &)
 Construct as copy. More...
 
 cyclicFvPatchField (const cyclicFvPatchField< vector > &, const DimensionedField< vector, volMesh > &)
 Construct as copy setting internal field reference. More...
 
const cyclicFvPatchcyclicPatch () const
 Return local reference cast into the cyclic patch. More...
 
const cyclicFvPatchField< vector > & neighbourPatchField () const
 Return reference to neighbour patchField. More...
 
virtual void manipulateMatrix (fvMatrix< vector > &m, const label iMatrix, const direction cmp)
 Manipulate matrix. More...
 
virtual bool doTransform () const
 Does the patch field perform the transformation. More...
 
virtual const tensorFieldforwardT () const
 Return face transformation tensor. More...
 
virtual const tensorFieldreverseT () const
 Return neighbour-cell transformation tensor. More...
 
virtual int rank () const
 Return rank of component for transform. More...
 
- Public Member Functions inherited from cyclicLduInterfaceField
 TypeName ("cyclicLduInterfaceField")
 Runtime type information. More...
 
 cyclicLduInterfaceField ()=default
 Construct null. More...
 
virtual ~cyclicLduInterfaceField ()=default
 Destructor. More...
 
template<class Type >
void transformCoupleField (Field< Type > &f) const
 Transform given patch field. More...
 
void transformCoupleField (solveScalarField &f, const direction cmpt) const
 Transform given patch component field. More...
 
- Public Member Functions inherited from coupledFvPatchField< vector >
 TypeName (coupledFvPatch::typeName_())
 Runtime type information. More...
 
 coupledFvPatchField (const fvPatch &, const DimensionedField< vector, volMesh > &)
 Construct from patch and internal field. More...
 
 coupledFvPatchField (const fvPatch &, const DimensionedField< vector, volMesh > &, const Field< vector > &)
 Construct from patch and internal field and patch field. More...
 
 coupledFvPatchField (const fvPatch &, const DimensionedField< vector, volMesh > &, const dictionary &, const bool valueRequired=true)
 Construct from patch, internal field and dictionary. More...
 
 coupledFvPatchField (const coupledFvPatchField< vector > &, const fvPatch &, const DimensionedField< vector, volMesh > &, const fvPatchFieldMapper &)
 Construct by mapping the given coupledFvPatchField onto a new patch. More...
 
 coupledFvPatchField (const coupledFvPatchField< vector > &)
 Construct as copy. More...
 
 coupledFvPatchField (const coupledFvPatchField< vector > &, const DimensionedField< vector, volMesh > &)
 Construct as copy setting internal field reference. More...
 
virtual bool coupled () const
 Return true if this patch field is derived from. More...
 
virtual tmp< Field< vector > > snGrad (const scalarField &deltaCoeffs) const
 Return patch-normal gradient. More...
 
virtual tmp< Field< vector > > snGrad () const
 Return patch-normal gradient. More...
 
virtual void initEvaluate (const Pstream::commsTypes commsType)
 Initialise the evaluation of the patch field. More...
 
virtual void evaluate (const Pstream::commsTypes commsType)
 Evaluate the patch field. More...
 
virtual tmp< Field< vector > > valueInternalCoeffs (const tmp< scalarField > &) const
 Return the matrix diagonal coefficients corresponding to the. More...
 
virtual tmp< Field< vector > > valueBoundaryCoeffs (const tmp< scalarField > &) const
 Return the matrix source coefficients corresponding to the. More...
 
virtual tmp< Field< vector > > gradientInternalCoeffs (const scalarField &deltaCoeffs) const
 Return the matrix diagonal coefficients corresponding to the. More...
 
virtual tmp< Field< vector > > gradientInternalCoeffs () const
 Return the matrix diagonal coefficients corresponding to the. More...
 
virtual tmp< Field< vector > > gradientBoundaryCoeffs (const scalarField &deltaCoeffs) const
 Return the matrix source coefficients corresponding to the. More...
 
virtual tmp< Field< vector > > gradientBoundaryCoeffs () const
 Return the matrix source coefficients corresponding to the. More...
 
- Public Member Functions inherited from LduInterfaceField< vector >
 LduInterfaceField (const lduInterface &patch)
 Construct given coupled patch. More...
 
 TypeName ("LduInterfaceField")
 Runtime type information. More...
 
virtual ~LduInterfaceField ()=default
 Destructor. More...
 
virtual void initInterfaceMatrixUpdate (Field< vector > &, const bool add, const lduAddressing &, const label interfacei, const Field< vector > &, const scalarField &, const Pstream::commsTypes commsType) const
 Initialise neighbour matrix update. More...
 
virtual void initInterfaceMatrixUpdate (solveScalarField &result, const bool add, const lduAddressing &, const label interfacei, const solveScalarField &psiInternal, const scalarField &coeffs, const direction cmpt, const Pstream::commsTypes commsType) const
 Inherit initInterfaceMatrixUpdate from lduInterfaceField. More...
 
virtual void updateInterfaceMatrix (solveScalarField &result, const bool add, const lduAddressing &, const label interfacei, const solveScalarField &psiInternal, const scalarField &coeffs, const direction cmpt, const Pstream::commsTypes commsType) const =0
 Inherit updateInterfaceMatrix from lduInterfaceField. More...
 
- Public Member Functions inherited from lduInterfaceField
 TypeName ("lduInterfaceField")
 Runtime type information. More...
 
 lduInterfaceField (const lduInterface &patch)
 Construct given coupled patch. More...
 
virtual ~lduInterfaceField ()=default
 Destructor. More...
 
const lduInterfaceinterface () const
 Return the interface. More...
 
bool updatedMatrix () const
 Whether matrix has been updated. More...
 
boolupdatedMatrix ()
 Whether matrix has been updated. More...
 
virtual bool ready () const
 Is all data available. More...
 
virtual void initInterfaceMatrixUpdate (solveScalarField &result, const bool add, const lduAddressing &, const label interfacei, const solveScalarField &psiInternal, const scalarField &coeffs, const direction cmpt, const Pstream::commsTypes commsType) const
 
template<class Type >
void addToInternalField (Field< Type > &result, const bool add, const labelUList &faceCells, const scalarField &coeffs, const Field< Type > &vals) const
 Add/subtract weighted contributions to internal field. More...
 
- Public Member Functions inherited from fvPatchField< vector >
 TypeName ("fvPatchField")
 Runtime type information. More...
 
 declareRunTimeSelectionTable (tmp, fvPatchField, patch,(const fvPatch &p, const DimensionedField< vector, volMesh > &iF),(p, iF))
 
 declareRunTimeSelectionTable (tmp, fvPatchField, patchMapper,(const fvPatchField< vector > &ptf, const fvPatch &p, const DimensionedField< vector, volMesh > &iF, const fvPatchFieldMapper &m),(dynamic_cast< const fvPatchFieldType & >(ptf), p, iF, m))
 
 declareRunTimeSelectionTable (tmp, fvPatchField, dictionary,(const fvPatch &p, const DimensionedField< vector, volMesh > &iF, const dictionary &dict),(p, iF, dict))
 
 fvPatchField (const fvPatch &, const DimensionedField< vector, volMesh > &)
 Construct from patch and internal field. More...
 
 fvPatchField (const fvPatch &, const DimensionedField< vector, volMesh > &, const vector &value)
 Construct from patch, internal field and value. More...
 
 fvPatchField (const fvPatch &, const DimensionedField< vector, volMesh > &, const word &patchType)
 Construct from patch and internal field and patch type. More...
 
 fvPatchField (const fvPatch &, const DimensionedField< vector, volMesh > &, const Field< vector > &)
 Construct from patch and internal field and patch field. More...
 
 fvPatchField (const fvPatch &, const DimensionedField< vector, volMesh > &, const dictionary &, const bool valueRequired=true)
 Construct from patch, internal field and dictionary. More...
 
 fvPatchField (const fvPatchField< vector > &, const fvPatch &, const DimensionedField< vector, volMesh > &, const fvPatchFieldMapper &)
 Construct by mapping the given fvPatchField onto a new patch. More...
 
 fvPatchField (const fvPatchField< vector > &)
 Construct as copy. More...
 
 fvPatchField (const fvPatchField< vector > &, const DimensionedField< vector, volMesh > &)
 Construct as copy setting internal field reference. More...
 
Foam::tmp< Foam::fvPatchField< vector > > NewCalculatedType (const fvPatchField< Type2 > &pf)
 
virtual ~fvPatchField ()=default
 Destructor. More...
 
bool useImplicit () const noexcept
 Use implicit formulation for coupled patches only. More...
 
bool useImplicit (bool on) noexcept
 Set useImplicit on/off. More...
 
virtual bool fixesValue () const
 Return true if this patch field fixes a value. More...
 
virtual bool assignable () const
 Return true if the value of the patch field. More...
 
const objectRegistrydb () const
 Return local objectRegistry. More...
 
const fvPatchpatch () const
 Return patch. More...
 
const DimensionedField< vector, volMesh > & internalField () const
 Return dimensioned internal field reference. More...
 
const Field< vector > & primitiveField () const
 Return internal field reference. More...
 
const wordpatchType () const
 Optional patch type. More...
 
wordpatchType ()
 Optional patch type. More...
 
bool updated () const
 Return true if the boundary condition has already been updated. More...
 
bool manipulatedMatrix () const
 Return true if the matrix has already been manipulated. More...
 
virtual void updateWeightedCoeffs (const scalarField &weights)
 Update the coefficients associated with the patch field. More...
 
virtual tmp< Field< vector > > patchInternalField () const
 Return internal field next to patch as patch field. More...
 
virtual void patchInternalField (Field< vector > &) const
 Return internal field next to patch as patch field. More...
 
virtual tmp< Field< vector > > valueInternalCoeffs (const tmp< Field< scalar >> &) const
 Return the matrix diagonal coefficients corresponding to the. More...
 
virtual tmp< Field< vector > > valueBoundaryCoeffs (const tmp< Field< scalar >> &) const
 Return the matrix source coefficients corresponding to the. More...
 
virtual void manipulateMatrix (fvMatrix< vector > &matrix)
 Manipulate matrix. More...
 
virtual void manipulateMatrix (fvMatrix< vector > &matrix, const scalarField &weights)
 Manipulate matrix with given weights. More...
 
void check (const fvPatchField< vector > &) const
 Check fvPatchField<Type> against given fvPatchField<Type> More...
 
virtual void operator= (const UList< vector > &)
 
virtual void operator= (const fvPatchField< vector > &)
 
virtual void operator= (const vector &)
 
virtual void operator+= (const fvPatchField< vector > &)
 
virtual void operator+= (const Field< vector > &)
 
virtual void operator+= (const vector &)
 
virtual void operator-= (const fvPatchField< vector > &)
 
virtual void operator-= (const Field< vector > &)
 
virtual void operator-= (const vector &)
 
virtual void operator*= (const fvPatchField< scalar > &)
 
virtual void operator*= (const Field< scalar > &)
 
virtual void operator*= (const scalar)
 
virtual void operator/= (const fvPatchField< scalar > &)
 
virtual void operator/= (const Field< scalar > &)
 
virtual void operator/= (const scalar)
 
virtual void operator== (const fvPatchField< vector > &)
 
virtual void operator== (const Field< vector > &)
 
virtual void operator== (const vector &)
 

Additional Inherited Members

- Public Types inherited from fvPatchField< vector >
typedef fvPatch Patch
 
typedef calculatedFvPatchField< vectorCalculated
 
- Static Public Member Functions inherited from fvPatchField< vector >
static tmp< fvPatchField< vector > > New (const word &, const fvPatch &, const DimensionedField< vector, volMesh > &)
 Return a pointer to a new patchField created on freestore given. More...
 
static tmp< fvPatchField< vector > > New (const word &, const word &actualPatchType, const fvPatch &, const DimensionedField< vector, volMesh > &)
 Return a pointer to a new patchField created on freestore given. More...
 
static tmp< fvPatchField< vector > > New (const fvPatchField< vector > &, const fvPatch &, const DimensionedField< vector, volMesh > &, const fvPatchFieldMapper &)
 Return a pointer to a new patchField created on freestore from. More...
 
static tmp< fvPatchField< vector > > New (const fvPatch &, const DimensionedField< vector, volMesh > &, const dictionary &)
 Return a pointer to a new patchField created on freestore. More...
 
static tmp< fvPatchField< vector > > NewCalculatedType (const fvPatch &)
 Return a pointer to a new calculatedFvPatchField created on. More...
 
static tmp< fvPatchField< vector > > NewCalculatedType (const fvPatchField< Type2 > &)
 Return a pointer to a new calculatedFvPatchField created on. More...
 
static const wordcalculatedType ()
 Return the type of the calculated for of fvPatchField. More...
 
- Static Public Attributes inherited from fvPatchField< vector >
static int disallowGenericFvPatchField
 Debug switch to disallow the use of genericFvPatchField. More...
 

Detailed Description

This boundary condition provides a jump condition for U across a cyclic pressure jump condition and applies a transformation to U.

The U-jump is specified with a swirl component as follows:

     Utan = deltaP/rEff/fanEff/(rpm*pi/30.0);

     where

        deltaP : pressure drop across the cyclic.
        rEff   : effective radius
        fanEff : fan efficiency coefficient
        rpm    : RPM of the fan

Alternatively an inner and outer radii can be used instead of rEff. The Utan is as follow for r > rInner and r < rOuter

        Utan = deltaP/r/fanEff/(rpm/pi/30.0);

        where

            r : p - origin, p is the face center

Outside rInner and rOuter, Utan = 0. The input for this mode is:

        useRealRadius   true;
        rInner          0.005;
        rOuter          0.01;

The radial velocity is zero in the present model.

Usage
Property Description Required Default
patchType underlying patch type should be cyclic yes
phi flux field name no phi
rho density field name no rho
p pressure field name no p
origin fan centre no calculated
rpm RPM of the fan yes
fanEff Fan efficiency no 1
rEff Effective radius no 0
useRealRadius Use inner/outer radii no false
rInner Inner radius no 0
rOuter Outer radius no 0

Example of the boundary condition specification:

    <patchName>
    {
        cyclicFaces_master
        {
            type            swirlFanVelocity;
            patchType       cyclic;
            jump            uniform (0 0 0);
            value           uniform (0 0 0);
            rpm             1000;
            rEff            0.01;
        }
    }
Source files

Definition at line 177 of file swirlFanVelocityFvPatchField.H.

Constructor & Destructor Documentation

◆ swirlFanVelocityFvPatchField() [1/5]

Construct from patch and internal field.

Definition at line 129 of file swirlFanVelocityFvPatchField.C.

Referenced by swirlFanVelocityFvPatchField::clone().

Here is the caller graph for this function:

◆ swirlFanVelocityFvPatchField() [2/5]

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

Construct from patch, internal field and dictionary.

Definition at line 149 of file swirlFanVelocityFvPatchField.C.

◆ swirlFanVelocityFvPatchField() [3/5]

swirlFanVelocityFvPatchField ( const swirlFanVelocityFvPatchField rhs,
const fvPatch p,
const DimensionedField< vector, volMesh > &  iF,
const fvPatchFieldMapper mapper 
)

Construct by mapping given swirlFanVelocityFvPatchField onto a new patch

Definition at line 184 of file swirlFanVelocityFvPatchField.C.

◆ swirlFanVelocityFvPatchField() [4/5]

Construct as copy.

Definition at line 206 of file swirlFanVelocityFvPatchField.C.

◆ swirlFanVelocityFvPatchField() [5/5]

Construct as copy setting internal field reference.

Definition at line 225 of file swirlFanVelocityFvPatchField.C.

Member Function Documentation

◆ TypeName()

TypeName ( "swirlFanVelocity"  )

Runtime type information.

◆ clone() [1/2]

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

Construct and return a clone.

Reimplemented from fixedJumpFvPatchField< vector >.

Definition at line 260 of file swirlFanVelocityFvPatchField.H.

References swirlFanVelocityFvPatchField::swirlFanVelocityFvPatchField().

Here is the call graph for this function:

◆ clone() [2/2]

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

Construct and return a clone setting internal field reference.

Reimplemented from fixedJumpFvPatchField< vector >.

Definition at line 277 of file swirlFanVelocityFvPatchField.H.

References swirlFanVelocityFvPatchField::swirlFanVelocityFvPatchField().

Here is the call graph for this function:

◆ updateCoeffs()

void updateCoeffs ( )
virtual

Update the coefficients associated with the patch field.

Reimplemented from fvPatchField< vector >.

Definition at line 246 of file swirlFanVelocityFvPatchField.C.

◆ write()

void write ( Ostream os) const
virtual

Write.

Reimplemented from fixedJumpFvPatchField< vector >.

Definition at line 257 of file swirlFanVelocityFvPatchField.C.

References os(), fixedJumpFvPatchField< Type >::write(), Ostream::writeEntry(), and Ostream::writeEntryIfDifferent().

Here is the call graph for this function:

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