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")

	swirlFanVelocityFvPatchField (const fvPatch &, const DimensionedField< vector, volMesh > &)

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

	swirlFanVelocityFvPatchField (const swirlFanVelocityFvPatchField &, const fvPatch &, const DimensionedField< vector, volMesh > &, const fvPatchFieldMapper &)

	swirlFanVelocityFvPatchField (const swirlFanVelocityFvPatchField &)

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

	swirlFanVelocityFvPatchField (const swirlFanVelocityFvPatchField &, const DimensionedField< vector, volMesh > &)

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

virtual void	updateCoeffs ()

virtual void	write (Ostream &os) const

Public Member Functions inherited from fixedJumpFvPatchField< vector >
	TypeName ("fixedJump")

	fixedJumpFvPatchField (const fvPatch &, const DimensionedField< vector, volMesh > &)

	fixedJumpFvPatchField (const fvPatch &, const DimensionedField< vector, volMesh > &, const dictionary &, const bool valueRequired=true)

	fixedJumpFvPatchField (const fixedJumpFvPatchField< vector > &, const fvPatch &, const DimensionedField< vector, volMesh > &, const fvPatchFieldMapper &)

	fixedJumpFvPatchField (const fixedJumpFvPatchField< vector > &)

	fixedJumpFvPatchField (const fixedJumpFvPatchField< vector > &, const DimensionedField< vector, volMesh > &)

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

virtual void	setJump (const Field< vector > &jump)

virtual void	setJump (const vector &jump)

virtual tmp< Field< vector > >	jump () const

virtual tmp< Field< vector > >	jump0 () const

virtual scalar	relaxFactor () const

virtual void	relax ()

virtual void	autoMap (const fvPatchFieldMapper &)

virtual void	rmap (const fvPatchField< vector > &, const labelList &)

Public Member Functions inherited from jumpCyclicFvPatchField< vector >
	TypeName ("jumpCyclic")

	jumpCyclicFvPatchField (const fvPatch &, const DimensionedField< vector, volMesh > &)

	jumpCyclicFvPatchField (const fvPatch &, const DimensionedField< vector, volMesh > &, const dictionary &, const bool valueRequired=true)

	jumpCyclicFvPatchField (const jumpCyclicFvPatchField< vector > &, const fvPatch &, const DimensionedField< vector, volMesh > &, const fvPatchFieldMapper &)

	jumpCyclicFvPatchField (const jumpCyclicFvPatchField< vector > &)

	jumpCyclicFvPatchField (const jumpCyclicFvPatchField< vector > &, const DimensionedField< vector, volMesh > &)

virtual const word &	interfaceFieldType () const

tmp< Field< vector > >	patchNeighbourField () const

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

virtual void	updateInterfaceMatrix (Field< vector > &, const bool add, const lduAddressing &lduAddr, const label patchId, const Field< vector > &, const scalarField &, const Pstream::commsTypes commsType) const

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

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

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

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

Public Member Functions inherited from cyclicFvPatchField< vector >
	TypeName (cyclicFvPatch::typeName_())

	cyclicFvPatchField (const fvPatch &, const DimensionedField< vector, volMesh > &)

	cyclicFvPatchField (const fvPatch &, const DimensionedField< vector, volMesh > &, const dictionary &, const bool valueRequired=true)

	cyclicFvPatchField (const cyclicFvPatchField< vector > &, const fvPatch &, const DimensionedField< vector, volMesh > &, const fvPatchFieldMapper &)

	cyclicFvPatchField (const cyclicFvPatchField< vector > &)

	cyclicFvPatchField (const cyclicFvPatchField< vector > &, const DimensionedField< vector, volMesh > &)

const cyclicFvPatch &	cyclicPatch () const

const cyclicFvPatchField< vector > &	neighbourPatchField () const

virtual void	manipulateMatrix (fvMatrix< vector > &m, const label iMatrix, const direction cmp)

virtual bool	doTransform () const

virtual const tensorField &	forwardT () const

virtual const tensorField &	reverseT () const

virtual int	rank () const

Public Member Functions inherited from cyclicLduInterfaceField
	TypeName ("cyclicLduInterfaceField")

	cyclicLduInterfaceField ()=default

virtual	~cyclicLduInterfaceField ()=default

virtual bool	doTransform () const =0

virtual const tensorField &	forwardT () const =0

virtual const tensorField &	reverseT () const =0

virtual int	rank () const =0

template<class Type >
void	transformCoupleField (Field< Type > &f) const

void	transformCoupleField (solveScalarField &f, const direction cmpt) const

Public Member Functions inherited from coupledFvPatchField< vector >
	TypeName (coupledFvPatch::typeName_())

	coupledFvPatchField (const fvPatch &, const DimensionedField< vector, volMesh > &)

	coupledFvPatchField (const fvPatch &, const DimensionedField< vector, volMesh > &, const Field< vector > &)

	coupledFvPatchField (const fvPatch &, const DimensionedField< vector, volMesh > &, const dictionary &, const bool valueRequired=true)

	coupledFvPatchField (const coupledFvPatchField< vector > &, const fvPatch &, const DimensionedField< vector, volMesh > &, const fvPatchFieldMapper &)

	coupledFvPatchField (const coupledFvPatchField< vector > &)

	coupledFvPatchField (const coupledFvPatchField< vector > &, const DimensionedField< vector, volMesh > &)

virtual bool	coupled () const

virtual tmp< Field< vector > >	snGrad (const scalarField &deltaCoeffs) const

virtual tmp< Field< vector > >	snGrad () const

virtual void	initEvaluate (const Pstream::commsTypes commsType)

virtual void	evaluate (const Pstream::commsTypes commsType)

virtual tmp< Field< vector > >	valueInternalCoeffs (const tmp< scalarField > &) const

virtual tmp< Field< vector > >	valueBoundaryCoeffs (const tmp< scalarField > &) const

virtual tmp< Field< vector > >	gradientInternalCoeffs (const scalarField &deltaCoeffs) const

virtual tmp< Field< vector > >	gradientInternalCoeffs () const

virtual tmp< Field< vector > >	gradientBoundaryCoeffs (const scalarField &deltaCoeffs) const

virtual tmp< Field< vector > >	gradientBoundaryCoeffs () const

Public Member Functions inherited from LduInterfaceField< vector >
	LduInterfaceField (const lduInterface &patch)

	TypeName ("LduInterfaceField")

virtual	~LduInterfaceField ()=default

virtual void	initInterfaceMatrixUpdate (Field< vector > &, const bool add, const lduAddressing &, const label interfacei, const Field< vector > &, const scalarField &, const Pstream::commsTypes commsType) const

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

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

Public Member Functions inherited from lduInterfaceField
	TypeName ("lduInterfaceField")

	lduInterfaceField (const lduInterface &patch)

virtual	~lduInterfaceField ()=default

const lduInterface &	interface () const

virtual const word &	interfaceFieldType () const

bool	updatedMatrix () const

bool &	updatedMatrix ()

virtual bool	ready () const

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

Public Member Functions inherited from fvPatchField< vector >
	TypeName ("fvPatchField")

	declareRunTimeSelectionTable (tmp, fvPatchField, patch,(const fvPatch &p, const DimensionedField< Type, volMesh > &iF),(p, iF))

	declareRunTimeSelectionTable (tmp, fvPatchField, patchMapper,(const fvPatchField< Type > &ptf, const fvPatch &p, const DimensionedField< Type, volMesh > &iF, const fvPatchFieldMapper &m),(dynamic_cast< const fvPatchFieldType & >(ptf), p, iF, m))

	declareRunTimeSelectionTable (tmp, fvPatchField, dictionary,(const fvPatch &p, const DimensionedField< Type, volMesh > &iF, const dictionary &dict),(p, iF, dict))

	fvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &)

	fvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &, const Type &value)

	fvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &, const word &patchType)

	fvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &, const Field< Type > &)

	fvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &, const dictionary &, const bool valueRequired=true)

	fvPatchField (const fvPatchField< Type > &, const fvPatch &, const DimensionedField< Type, volMesh > &, const fvPatchFieldMapper &)

	fvPatchField (const fvPatchField< Type > &)

	fvPatchField (const fvPatchField< Type > &, const DimensionedField< Type, volMesh > &)

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

Foam::tmp< Foam::fvPatchField< Type > >	NewCalculatedType (const fvPatch &p)

Foam::tmp< Foam::fvPatchField< Type > >	NewCalculatedType (const fvPatchField< Type2 > &pf)

virtual	~fvPatchField ()=default

bool	useImplicit () const noexcept

bool	useImplicit (bool on) noexcept

virtual bool	fixesValue () const

virtual bool	assignable () const

const objectRegistry &	db () const

const fvPatch &	patch () const

const DimensionedField< Type, volMesh > &	internalField () const

const Field< Type > &	primitiveField () const

const word &	patchType () const

word &	patchType ()

bool	updated () const

bool	manipulatedMatrix () const

virtual void	rmap (const fvPatchField< Type > &, const labelList &)

virtual void	updateWeightedCoeffs (const scalarField &weights)

virtual tmp< Field< Type > >	patchInternalField () const

virtual void	patchInternalField (Field< Type > &) const

virtual tmp< Field< Type > >	valueInternalCoeffs (const tmp< Field< scalar >> &) const

virtual tmp< Field< Type > >	valueBoundaryCoeffs (const tmp< Field< scalar >> &) const

virtual void	manipulateMatrix (fvMatrix< Type > &matrix)

virtual void	manipulateMatrix (fvMatrix< Type > &matrix, const scalarField &weights)

virtual void	manipulateMatrix (fvMatrix< Type > &matrix, const label iMatrix, const direction cmp)

void	check (const fvPatchField< Type > &) const

virtual void	operator= (const UList< Type > &)

virtual void	operator= (const fvPatchField< Type > &)

virtual void	operator= (const Type &)

virtual void	operator+= (const fvPatchField< Type > &)

virtual void	operator+= (const Field< Type > &)

virtual void	operator+= (const Type &)

virtual void	operator-= (const fvPatchField< Type > &)

virtual void	operator-= (const Field< Type > &)

virtual void	operator-= (const Type &)

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< Type > &)

virtual void	operator== (const Field< Type > &)

virtual void	operator== (const Type &)

Additional Inherited Members
Public Types inherited from fvPatchField< vector >
typedef fvPatch	Patch

typedef calculatedFvPatchField< Type >	Calculated

Static Public Member Functions inherited from fvPatchField< vector >
static tmp< fvPatchField< Type > >	New (const word &, const fvPatch &, const DimensionedField< Type, volMesh > &)

static tmp< fvPatchField< Type > >	New (const word &, const word &actualPatchType, const fvPatch &, const DimensionedField< Type, volMesh > &)

static tmp< fvPatchField< Type > >	New (const fvPatchField< Type > &, const fvPatch &, const DimensionedField< Type, volMesh > &, const fvPatchFieldMapper &)

static tmp< fvPatchField< Type > >	New (const fvPatch &, const DimensionedField< Type, volMesh > &, const dictionary &)

static tmp< fvPatchField< Type > >	NewCalculatedType (const fvPatch &)

static tmp< fvPatchField< Type > >	NewCalculatedType (const fvPatchField< Type2 > &)

static const word &	calculatedType ()

Static Public Attributes inherited from fvPatchField< vector >
static int	disallowGenericFvPatchField

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 173 of file swirlFanVelocityFvPatchField.H.

Constructor & Destructor Documentation

◆ swirlFanVelocityFvPatchField() [1/5]

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

Definition at line 122 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
	)

Definition at line 142 of file swirlFanVelocityFvPatchField.C.

◆ swirlFanVelocityFvPatchField() [3/5]

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

Definition at line 177 of file swirlFanVelocityFvPatchField.C.

◆ swirlFanVelocityFvPatchField() [4/5]

swirlFanVelocityFvPatchField ( const swirlFanVelocityFvPatchField & rhs )

Definition at line 199 of file swirlFanVelocityFvPatchField.C.

◆ swirlFanVelocityFvPatchField() [5/5]

swirlFanVelocityFvPatchField	(	const swirlFanVelocityFvPatchField &	rhs,
		const DimensionedField< vector, volMesh > &	iF
	)

Definition at line 218 of file swirlFanVelocityFvPatchField.C.

Member Function Documentation

◆ TypeName()

TypeName ( "swirlFanVelocity" )

◆ clone() [1/2]

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

inlinevirtual

Definition at line 256 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

Reimplemented from fixedJumpFvPatchField< vector >.

Definition at line 273 of file swirlFanVelocityFvPatchField.H.

References swirlFanVelocityFvPatchField::swirlFanVelocityFvPatchField().

Here is the call graph for this function:

◆ updateCoeffs()

void updateCoeffs ( )

virtual

Reimplemented from fvPatchField< vector >.

Definition at line 239 of file swirlFanVelocityFvPatchField.C.

◆ write()

void write ( Ostream & os ) const

virtual

Reimplemented from fixedJumpFvPatchField< vector >.

Definition at line 250 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:

src/finiteVolume/fields/fvPatchFields/derived/swirlFanVelocity/swirlFanVelocityFvPatchField.H
src/finiteVolume/fields/fvPatchFields/derived/swirlFanVelocity/swirlFanVelocityFvPatchField.C

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ swirlFanVelocityFvPatchField() [1/5]

◆ swirlFanVelocityFvPatchField() [2/5]

◆ swirlFanVelocityFvPatchField() [3/5]

◆ swirlFanVelocityFvPatchField() [4/5]

◆ swirlFanVelocityFvPatchField() [5/5]

Member Function Documentation

◆ TypeName()

◆ clone() [1/2]

◆ clone() [2/2]

◆ updateCoeffs()

◆ write()