This boundary condition provides a jump condition, using the cyclic condition as a base. More...

Inheritance diagram for fanFvPatchField< Type >:

Collaboration diagram for fanFvPatchField< Type >:

Public Member Functions
	TypeName ("fan")

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

	fanFvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &, const dictionary &)

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

	fanFvPatchField (const fanFvPatchField< Type > &)

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

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

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

virtual void	updateCoeffs ()

virtual void	write (Ostream &os) const

Public Member Functions inherited from uniformJumpFvPatchField< Type >
	TypeName ("uniformJump")

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

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

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

	uniformJumpFvPatchField (const uniformJumpFvPatchField< Type > &)

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

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

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

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

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

	fixedJumpFvPatchField (const fixedJumpFvPatchField< Type > &)

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

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

virtual void	setJump (const Type &jump)

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

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

virtual scalar	relaxFactor () const

virtual void	relax ()

virtual void	autoMap (const fvPatchFieldMapper &)

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

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

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

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

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

	jumpCyclicFvPatchField (const jumpCyclicFvPatchField< Type > &)

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

virtual const word &	interfaceFieldType () const

tmp< Field< Type > >	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< Type > &, const bool add, const lduAddressing &lduAddr, const label patchId, const Field< Type > &, 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< Type >
	TypeName (cyclicFvPatch::typeName_())

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

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

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

	cyclicFvPatchField (const cyclicFvPatchField< Type > &)

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

const cyclicFvPatch &	cyclicPatch () const

const cyclicFvPatchField< Type > &	neighbourPatchField () const

virtual void	manipulateMatrix (fvMatrix< Type > &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

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

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

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

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

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

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

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

	coupledFvPatchField (const coupledFvPatchField< Type > &)

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

virtual bool	coupled () const

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

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

virtual void	initEvaluate (const Pstream::commsTypes commsType)

virtual void	evaluate (const Pstream::commsTypes commsType)

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

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

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

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

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

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

Public Member Functions inherited from LduInterfaceField< Type >
	TypeName ("LduInterfaceField")

	LduInterfaceField (const lduInterface &patch)

virtual	~LduInterfaceField ()=default

virtual void	initInterfaceMatrixUpdate (Field< Type > &, const bool add, const lduAddressing &, const label interfacei, const Field< Type > &, 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

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

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

virtual bool	coupled () 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 tmp< Field< Type > >	snGrad () const

virtual void	updateWeightedCoeffs (const scalarField &weights)

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

virtual void	patchInternalField (Field< Type > &) const

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

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

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

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

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

virtual void	manipulateMatrix (fvMatrix< Type > &matrix)

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

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< Type >
typedef fvPatch	Patch

typedef calculatedFvPatchField< Type >	Calculated

Static Public Member Functions inherited from fvPatchField< Type >
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< Type >
static int	disallowGenericFvPatchField

Protected Attributes inherited from uniformJumpFvPatchField< Type >
autoPtr< Function1< Type > >	jumpTable_

Detailed Description

template<class Type>
class Foam::fanFvPatchField< Type >

This boundary condition provides a jump condition, using the cyclic condition as a base.

The jump is specified as a Function1 type, to enable the use of, e.g. constant, polynomial, table values.

The switch nonDimensional can be used for a non-dimensional table, in combination with uniformJump = true. As inputs it needs the fan RPM (rpm) and the mean diameter (dm).

The non-dimensional U for the table is calculated as follows:

    phi = 120*Un/(PI^3*dm*rpm)
    where:
        dm is the mean diameter.
        rpm is the RPM of the fan.

The non-dimensional pressure:

    Psi = 2 deltaP/(rho*(sqr(PI*omega*dm)))
    where:
        deltaP is the pressure drop

The non-dimensional table should be given as Psi = F(phi).

Usage

Property	Description	Required	Default
`patchType`	underlying patch type should be `cyclic`	yes
`jumpTable`	jump data, e.g. `csvFile`	yes
`phi`	flux field name	no	phi
`rho`	density field name	no	rho
`uniformJump`	apply uniform pressure based on avg velocity	no	false
`nonDimensional`	use non-dimensional table	no	false
`rpm`	fan rpm (non-dimensional table)	no
`dm`	mean diameter (non-dimensional table)	no

Example of the boundary condition specification:

    <patchName>
    {
        type            fan;
        patchType       cyclic;
        jumpTable       csvFile;

        jumpTableCoeffs
        {
            nHeaderLine     1;
            refColumn       0;
            componentColumns 1(1);
            separator       ",";
            mergeSeparators no;
            file            "<constant>/UvsPressure";
        }
        value           uniform 0;
    }

The above example shows the use of a comma separated (CSV) file to specify the jump condition.

Note: The underlying patchType should be set to cyclic

See also: Foam::Function1Types

Source files

Definition at line 170 of file fanFvPatchField.H.

Constructor & Destructor Documentation

◆ fanFvPatchField() [1/5]

fanFvPatchField	(	const fvPatch &	p,
		const DimensionedField< Type, volMesh > &	iF
	)

Definition at line 40 of file fanFvPatchField.C.

◆ fanFvPatchField() [2/5]

fanFvPatchField	(	const fvPatch &	p,
		const DimensionedField< Type, volMesh > &	iF,
		const dictionary &	dict
	)

Definition at line 57 of file fanFvPatchField.C.

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

Here is the call graph for this function:

◆ fanFvPatchField() [3/5]

fanFvPatchField	(	const fanFvPatchField< Type > &	rhs,
		const fvPatch &	p,
		const DimensionedField< Type, volMesh > &	iF,
		const fvPatchFieldMapper &	mapper
	)

Definition at line 99 of file fanFvPatchField.C.

◆ fanFvPatchField() [4/5]

fanFvPatchField ( const fanFvPatchField< Type > & rhs )

Definition at line 118 of file fanFvPatchField.C.

◆ fanFvPatchField() [5/5]

fanFvPatchField	(	const fanFvPatchField< Type > &	rhs,
		const DimensionedField< Type, volMesh > &	iF
	)

Definition at line 134 of file fanFvPatchField.C.

Member Function Documentation

◆ TypeName()

TypeName ( "fan" )

◆ clone() [1/2]

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

inlinevirtual

Reimplemented from uniformJumpFvPatchField< Type >.

Definition at line 240 of file fanFvPatchField.H.

◆ clone() [2/2]

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

inlinevirtual

Reimplemented from uniformJumpFvPatchField< Type >.

Definition at line 257 of file fanFvPatchField.H.

◆ updateCoeffs()

void updateCoeffs

virtual

Reimplemented from uniformJumpFvPatchField< Type >.

Definition at line 152 of file fanFvPatchField.C.

◆ write()

void write ( Ostream & os ) const

virtual

Reimplemented from uniformJumpFvPatchField< Type >.

Definition at line 167 of file fanFvPatchField.C.

References os(), and Foam::vtk::write().

Here is the call graph for this function:

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

src/finiteVolume/fields/fvPatchFields/derived/fan/fanFvPatchField.H
src/finiteVolume/fields/fvPatchFields/derived/fan/fanFvPatchField.C

Public Member Functions

Additional Inherited Members

Detailed Description

template<class Type> class Foam::fanFvPatchField< Type >

Constructor & Destructor Documentation

◆ fanFvPatchField() [1/5]

◆ fanFvPatchField() [2/5]

◆ fanFvPatchField() [3/5]

◆ fanFvPatchField() [4/5]

◆ fanFvPatchField() [5/5]

Member Function Documentation

◆ TypeName()

◆ clone() [1/2]

◆ clone() [2/2]

◆ updateCoeffs()

◆ write()

template<class Type>
class Foam::fanFvPatchField< Type >