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

Private Attributes
const word	phiName_
	Name of the flux transporting the field. More...

const word	rhoName_
	Name of the density field used to normalize the mass flux. More...

autoPtr< DataEntry< scalar > >	flowRate_
	Inlet integral flow rate. More...

autoPtr< DataEntry< scalar > >	rpm_
	Angular speed in revolutions per minute (RPM) 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.

Patch usage

Property	Description	Required	Default value
`phi`	flux field name	no	phi
`rho`	density field name	no	rho
`flowRate`	flow rate profile	yes
`rpm`	rotational speed profile	yes

Example of the boundary condition specification:

    myPatch
    {
        type            swirlFlowRateInletVelocity;
        flowRate        constant 0.2;
        rpm             constant 100;
    }

Note

the flowRate and rpm entries are DataEntry 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

Source files

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

Referenced by swirlFlowRateInletVelocityFvPatchVectorField::clone().

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

◆ swirlFlowRateInletVelocityFvPatchVectorField() [4/5]

swirlFlowRateInletVelocityFvPatchVectorField ( const swirlFlowRateInletVelocityFvPatchVectorField & ptf )

Construct as copy.

Definition at line 85 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 99 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 172 of file swirlFlowRateInletVelocityFvPatchVectorField.H.

References swirlFlowRateInletVelocityFvPatchVectorField::swirlFlowRateInletVelocityFvPatchVectorField().

Here is the call graph for this function:

◆ 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 189 of file swirlFlowRateInletVelocityFvPatchVectorField.H.

References swirlFlowRateInletVelocityFvPatchVectorField::swirlFlowRateInletVelocityFvPatchVectorField().

Here is the call graph for this function:

◆ updateCoeffs()

void updateCoeffs ( )

virtual

Update the coefficients associated with the patch field.

Definition at line 114 of file swirlFlowRateInletVelocityFvPatchVectorField.C.

References Foam::dimArea, Foam::dimDensity, dimensionedInternalField(), Foam::dimVelocity, Foam::exit(), Foam::FatalError, FatalErrorInFunction, swirlFlowRateInletVelocityFvPatchVectorField::flowRate_, Foam::gSum(), n, Foam::nl, Foam::operator==(), phi, swirlFlowRateInletVelocityFvPatchVectorField::phiName_, Foam::constant::mathematical::pi(), swirlFlowRateInletVelocityFvPatchVectorField::rhoName_, swirlFlowRateInletVelocityFvPatchVectorField::rpm_, and fvPatchField< Type >::updateCoeffs().

Here is the call graph for this function:

◆ write()

void write ( Ostream & os ) const

virtual

Write.

Definition at line 171 of file swirlFlowRateInletVelocityFvPatchVectorField.C.

References fvPatchField::write().

Here is the call graph for this function:

Field Documentation

◆ phiName_

const word phiName_

private

Name of the flux transporting the field.

Definition at line 119 of file swirlFlowRateInletVelocityFvPatchVectorField.H.

Referenced by swirlFlowRateInletVelocityFvPatchVectorField::updateCoeffs().

◆ rhoName_

const word rhoName_

private

Name of the density field used to normalize the mass flux.

Definition at line 122 of file swirlFlowRateInletVelocityFvPatchVectorField.H.

Referenced by swirlFlowRateInletVelocityFvPatchVectorField::updateCoeffs().

◆ flowRate_

autoPtr<DataEntry<scalar> > flowRate_

private

Inlet integral flow rate.

Definition at line 125 of file swirlFlowRateInletVelocityFvPatchVectorField.H.

Referenced by swirlFlowRateInletVelocityFvPatchVectorField::updateCoeffs().

◆ rpm_

autoPtr<DataEntry<scalar> > rpm_

private

Angular speed in revolutions per minute (RPM)

Definition at line 128 of file swirlFlowRateInletVelocityFvPatchVectorField.H.

Referenced by swirlFlowRateInletVelocityFvPatchVectorField::updateCoeffs().

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

Private Attributes

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

Field Documentation

◆ phiName_

◆ rhoName_

◆ flowRate_

◆ rpm_