This boundary condition describes an inlet vector boundary condition in swirl coordinates given a central axis, central point, axial, radial and tangential velocity profiles. More...

Inheritance diagram for swirlInletVelocityFvPatchVectorField:

[legend]

Collaboration diagram for swirlInletVelocityFvPatchVectorField:

[legend]

Public Member Functions
	TypeName ("swirlInletVelocity")
	Runtime type information. More...

	swirlInletVelocityFvPatchVectorField (const fvPatch &, const DimensionedField< vector, volMesh > &)
	Construct from patch and internal field. 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 fvPatchFieldMapper &)
	Construct by mapping given. More...

	swirlInletVelocityFvPatchVectorField (const swirlInletVelocityFvPatchVectorField &)
	Construct as copy. More...

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

	swirlInletVelocityFvPatchVectorField (const swirlInletVelocityFvPatchVectorField &, 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 describes an inlet vector boundary condition in swirl coordinates given a central axis, central point, axial, radial and tangential velocity profiles.

Usage

Property	Description	Required
`axis`	Axis of rotation	yes
`origin`	Origin of rotation	yes
`axialVelocity`	Axial velocity profile [m/s]	yes
`radialVelocity`	Radial velocity profile [m/s]	yes
`tangentialVelocity`	tangential velocity profile [m/s]	yes

Example of the boundary condition specification:

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

Note: The axialVelocity, radialVelocity and tangentialVelocity entries are Function1 types, able to describe time varying functions. The example above gives the usage for supplying constant values.

See also: Foam::fixedValueFvPatchField Foam::Function1Types

Source files

Definition at line 117 of file swirlInletVelocityFvPatchVectorField.H.

Constructor & Destructor Documentation

◆ swirlInletVelocityFvPatchVectorField() [1/5]

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

Construct from patch and internal field.

Definition at line 34 of file swirlInletVelocityFvPatchVectorField.C.

◆ swirlInletVelocityFvPatchVectorField() [2/5]

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

Construct from patch, internal field and dictionary.

Definition at line 68 of file swirlInletVelocityFvPatchVectorField.C.

◆ swirlInletVelocityFvPatchVectorField() [3/5]

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

Construct by mapping given.

flowRateInletVelocityFvPatchVectorField onto a new patch

Definition at line 50 of file swirlInletVelocityFvPatchVectorField.C.

◆ swirlInletVelocityFvPatchVectorField() [4/5]

swirlInletVelocityFvPatchVectorField ( const swirlInletVelocityFvPatchVectorField & ptf )

Construct as copy.

Definition at line 91 of file swirlInletVelocityFvPatchVectorField.C.

◆ swirlInletVelocityFvPatchVectorField() [5/5]

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

Construct as copy setting internal field reference.

Definition at line 106 of file swirlInletVelocityFvPatchVectorField.C.

Member Function Documentation

◆ TypeName()

TypeName ( "swirlInletVelocity" )

Runtime type information.

◆ clone() [1/2]

virtual tmp< fvPatchVectorField > clone ( ) const

inlinevirtual

Construct and return a clone.

Definition at line 180 of file swirlInletVelocityFvPatchVectorField.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 196 of file swirlInletVelocityFvPatchVectorField.H.

◆ updateCoeffs()

void updateCoeffs ( )

virtual

Update the coefficients associated with the patch field.

Definition at line 124 of file swirlInletVelocityFvPatchVectorField.C.

References Foam::mag(), and atmBoundaryLayerInletEpsilonFvPatchScalarField::updateCoeffs().

Here is the call graph for this function:

◆ write()

void write ( Ostream & os ) const