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

#include <swirlFlowRateInletVelocityFvPatchVectorField.H>

Inheritance diagram for swirlFlowRateInletVelocityFvPatchVectorField:

[legend]

Collaboration diagram for swirlFlowRateInletVelocityFvPatchVectorField:

[legend]

Public Member Functions
	TypeName ("swirlFlowRateInletVelocity")
	Runtime type information.
	swirlFlowRateInletVelocityFvPatchVectorField (const fvPatch &, const DimensionedField< vector, volMesh > &)
	Construct from patch and internal field.
	swirlFlowRateInletVelocityFvPatchVectorField (const fvPatch &, const DimensionedField< vector, volMesh > &, const dictionary &)
	Construct from patch, internal field and dictionary.
	swirlFlowRateInletVelocityFvPatchVectorField (const swirlFlowRateInletVelocityFvPatchVectorField &, const fvPatch &, const DimensionedField< vector, volMesh > &, const fvPatchFieldMapper &)
	Construct by mapping given.
	swirlFlowRateInletVelocityFvPatchVectorField (const swirlFlowRateInletVelocityFvPatchVectorField &)
	Construct as copy.
	swirlFlowRateInletVelocityFvPatchVectorField (const swirlFlowRateInletVelocityFvPatchVectorField &, const DimensionedField< vector, volMesh > &)
	Construct as copy setting internal field reference.
virtual tmp< fvPatchField< vector > >	clone () const
	Return a clone.
virtual tmp< fvPatchField< vector > >	clone (const DimensionedField< vector, volMesh > &iF) const
	Clone with an internal field reference.
virtual void	updateCoeffs ()
	Update the coefficients associated with the patch field.
virtual void	write (Ostream &) const
	Write.

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 122 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 31 of file swirlFlowRateInletVelocityFvPatchVectorField.C.

References p, and Foam::Zero.

Referenced by swirlFlowRateInletVelocityFvPatchVectorField(), swirlFlowRateInletVelocityFvPatchVectorField(), swirlFlowRateInletVelocityFvPatchVectorField(), and TypeName().

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

References dict, Foam::gSum(), Foam::gWeightedAverage(), Foam::New(), p, Foam::returnReduceOr(), and Foam::Zero.

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

References clone(), p, and swirlFlowRateInletVelocityFvPatchVectorField().

Here is the call graph for this function:

◆ swirlFlowRateInletVelocityFvPatchVectorField() [4/5]

swirlFlowRateInletVelocityFvPatchVectorField ( const swirlFlowRateInletVelocityFvPatchVectorField & ptf )

Construct as copy.

Definition at line 103 of file swirlFlowRateInletVelocityFvPatchVectorField.C.

References clone(), and swirlFlowRateInletVelocityFvPatchVectorField().

Here is the call graph for this function:

◆ swirlFlowRateInletVelocityFvPatchVectorField() [5/5]

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

Construct as copy setting internal field reference.

Definition at line 119 of file swirlFlowRateInletVelocityFvPatchVectorField.C.

References clone(), and swirlFlowRateInletVelocityFvPatchVectorField().

Here is the call graph for this function:

Member Function Documentation

◆ TypeName()

TypeName ( "swirlFlowRateInletVelocity" )

Runtime type information.

References swirlFlowRateInletVelocityFvPatchVectorField().

Here is the call graph for this function:

◆ clone() [1/2]

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

inlinevirtual

Return a clone.

Definition at line 222 of file swirlFlowRateInletVelocityFvPatchVectorField.H.

References fvPatchField< Type >::Clone().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ clone() [2/2]

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

inlinevirtual

Clone with an internal field reference.

Definition at line 230 of file swirlFlowRateInletVelocityFvPatchVectorField.H.

References fvPatchField< Type >::Clone().

Here is the call graph for this function:

◆ updateCoeffs()

void updateCoeffs ( )

virtual

Update the coefficients associated with the patch field.

Definition at line 138 of file swirlFlowRateInletVelocityFvPatchVectorField.C.

References Foam::dimMass, Foam::dimTime, Foam::dimVolume, Foam::exit(), Foam::FatalError, FatalErrorInFunction, Foam::gSum(), Foam::mag(), n, Foam::nl, Foam::operator==(), phi, Foam::rpmToRads(), fvPatchField< Type >::updateCoeffs(), and Foam::Zero.

Here is the call graph for this function:

◆ write()

void write ( Ostream & os ) const

virtual

Write.

Definition at line 194 of file swirlFlowRateInletVelocityFvPatchVectorField.C.

References os(), fvPatchField< Type >::write(), and fvPatchField< Type >::writeValueEntry().

Here is the call graph for this function:

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

src/finiteVolume/fields/fvPatchFields/derived/swirlFlowRateInletVelocity/swirlFlowRateInletVelocityFvPatchVectorField.H
src/finiteVolume/fields/fvPatchFields/derived/swirlFlowRateInletVelocity/swirlFlowRateInletVelocityFvPatchVectorField.C

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ swirlFlowRateInletVelocityFvPatchVectorField() [1/5]

◆ swirlFlowRateInletVelocityFvPatchVectorField() [2/5]

◆ swirlFlowRateInletVelocityFvPatchVectorField() [3/5]

◆ swirlFlowRateInletVelocityFvPatchVectorField() [4/5]

◆ swirlFlowRateInletVelocityFvPatchVectorField() [5/5]

Member Function Documentation

◆ TypeName()

◆ clone() [1/2]

◆ clone() [2/2]

◆ updateCoeffs()

◆ write()