swirlInletVelocityFvPatchVectorField Class Reference

Velocity inlet boundary condition creating axial, radial and tangential velocity fields specified by functions of time and radius or by a given angular speed. More...

Inheritance diagram for swirlInletVelocityFvPatchVectorField:

Collaboration diagram for swirlInletVelocityFvPatchVectorField:

Public Member Functions
	TypeName ("swirlInletVelocity")
	Runtime type information. More...
	swirlInletVelocityFvPatchVectorField (const fvPatch &, const DimensionedField< vector, volMesh > &, const dictionary &)
	Construct from patch, internal field and dictionary. More...
	swirlInletVelocityFvPatchVectorField (const swirlInletVelocityFvPatchVectorField &, const fvPatch &, const DimensionedField< vector, volMesh > &, const fieldMapper &)
	Construct by mapping given. More...
	swirlInletVelocityFvPatchVectorField (const swirlInletVelocityFvPatchVectorField &)=delete
	Disallow copy without setting internal field reference. More...
	swirlInletVelocityFvPatchVectorField (const swirlInletVelocityFvPatchVectorField &, const DimensionedField< vector, volMesh > &)
	Copy constructor 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

Velocity inlet boundary condition creating axial, radial and tangential velocity fields specified by functions of time and radius or by a given angular speed.

Usage

Property	Description	Required	Default value
origin	Origin of rotation	no	patch centre
axis	Axis of rotation	no	patch normal
axialVelocity	Axial velocity [m/s]	yes
radialVelocity	Radial velocity [m/s]	yes
omega	Angular velocity of the frame	no
tangentialVelocity	Tangential velocity [m/s]	no

Example of the boundary condition specification:

    <patchName>
    {
        type            swirlInletVelocity;
        origin          (0 0 0);
        axis            (0 0 1);
        axialVelocity   constant 30;
        radialVelocity  constant 10;
        tangentialVelocity  constant 100;
    }

The axialVelocity, radialVelocity and tangentialVelocity entries are Function2 of time and radius, see see Foam::Function2s. The omega is a Function1 of time, see Foam::Function1s.

See also

Foam::fixedValueFvPatchField Foam::Function1s Foam::Function2s

Source files

• swirlInletVelocityFvPatchVectorField.H
• swirlInletVelocityFvPatchVectorField.C

Definition at line 119 of file swirlInletVelocityFvPatchVectorField.H.

Constructor & Destructor Documentation

swirlInletVelocityFvPatchVectorField() [1/4]

swirlInletVelocityFvPatchVectorField	(	const fvPatch &	p,
		const DimensionedField< vector, volMesh > &	iF,
		const dictionary &	dict
	)

Construct from patch, internal field and dictionary.

Definition at line 31 of file swirlInletVelocityFvPatchVectorField.C.

References UPstream::blocking, dict, DimensionedField< Type, GeoMesh >::dimensions(), Foam::dimLength, Foam::dimVelocity, Foam::evaluate(), Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, Function2< Type >::New(), omega, and p.

Referenced by swirlInletVelocityFvPatchVectorField::clone().

Here is the call graph for this function:

Here is the caller graph for this function:

swirlInletVelocityFvPatchVectorField() [2/4]

swirlInletVelocityFvPatchVectorField	(	const swirlInletVelocityFvPatchVectorField &	ptf,
		const fvPatch &	p,
		const DimensionedField< vector, volMesh > &	iF,
		const fieldMapper &	mapper
	)

Construct by mapping given.

flowRateInletVelocityFvPatchVectorField onto a new patch

Definition at line 124 of file swirlInletVelocityFvPatchVectorField.C.

swirlInletVelocityFvPatchVectorField() [3/4]

swirlInletVelocityFvPatchVectorField ( const swirlInletVelocityFvPatchVectorField &  )

delete

Disallow copy without setting internal field reference.

swirlInletVelocityFvPatchVectorField() [4/4]

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

Copy constructor setting internal field reference.

Definition at line 143 of file swirlInletVelocityFvPatchVectorField.C.

Member Function Documentation

TypeName()

TypeName

(

"swirlInletVelocity"

)

Runtime type information.

clone()

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

inlinevirtual

Construct and return a clone setting internal field reference.

Definition at line 185 of file swirlInletVelocityFvPatchVectorField.H.

References swirlInletVelocityFvPatchVectorField::swirlInletVelocityFvPatchVectorField().

Here is the call graph for this function:

updateCoeffs()

void updateCoeffs ( )

virtual

Update the coefficients associated with the patch field.

Definition at line 162 of file swirlInletVelocityFvPatchVectorField.C.

References Foam::mag(), Foam::normalised(), and fvPatchField< Type >::updateCoeffs().

Here is the call graph for this function:

write()

void write ( Ostream &  os ) const

virtual

Write.

Definition at line 204 of file swirlInletVelocityFvPatchVectorField.C.

References Foam::dimLength, Foam::dimVelocity, fvPatchField< Type >::write(), and Foam::writeEntry().

Here is the call graph for this function:

---

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

• src/finiteVolume/fields/fvPatchFields/derived/swirlInletVelocity/swirlInletVelocityFvPatchVectorField.H
• src/finiteVolume/fields/fvPatchFields/derived/swirlInletVelocity/swirlInletVelocityFvPatchVectorField.C