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:

[legend]

Collaboration diagram for swirlFlowRateInletVelocityFvPatchVectorField:

[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 &)
	Construct as copy. More...

virtual tmp< fvPatchVectorField >	clone () const
	Construct and return a clone. More...

	swirlFlowRateInletVelocityFvPatchVectorField (const swirlFlowRateInletVelocityFvPatchVectorField &, const DimensionedField< vector, volMesh > &)
	Construct as copy 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::Function1Types

Source files

Definition at line 126 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 38 of file swirlFlowRateInletVelocityFvPatchVectorField.C.

◆ 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 55 of file swirlFlowRateInletVelocityFvPatchVectorField.C.

◆ 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 91 of file swirlFlowRateInletVelocityFvPatchVectorField.C.

◆ swirlFlowRateInletVelocityFvPatchVectorField() [4/5]

swirlFlowRateInletVelocityFvPatchVectorField ( const swirlFlowRateInletVelocityFvPatchVectorField & ptf )

Construct as copy.

Definition at line 110 of file swirlFlowRateInletVelocityFvPatchVectorField.C.

◆ swirlFlowRateInletVelocityFvPatchVectorField() [5/5]

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

Construct as copy setting internal field reference.

Definition at line 126 of file swirlFlowRateInletVelocityFvPatchVectorField.C.

Member Function Documentation

◆ TypeName()

TypeName ( "swirlFlowRateInletVelocity" )

Runtime type information.

◆ clone() [1/2]

virtual tmp< fvPatchVectorField > clone ( ) const

inlinevirtual

Construct and return a clone.

Definition at line 192 of file swirlFlowRateInletVelocityFvPatchVectorField.H.

◆ clone() [2/2]

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

inlinevirtual

Construct and return a clone setting internal field reference.

Definition at line 208 of file swirlFlowRateInletVelocityFvPatchVectorField.H.

◆ updateCoeffs()

void updateCoeffs ( )

virtual

Update the coefficients associated with the patch field.

Definition at line 145 of file swirlFlowRateInletVelocityFvPatchVectorField.C.

References Foam::dimArea, Foam::dimDensity, DimensionedField< Type, GeoMesh >::dimensions(), Foam::dimVelocity, Foam::exit(), Foam::FatalError, FatalErrorInFunction, Foam::gSum(), Foam::mag(), n, Foam::nl, Foam::operator==(), phi, Foam::rpmToRads(), atmBoundaryLayerInletEpsilonFvPatchScalarField::updateCoeffs(), and Foam::Zero.

Here is the call graph for this function:

◆ write()

void write ( Ostream & os ) const