Freestream velocity condition to be used in conjunction with the single rotating frame (SRF) model (see: SRFModel class) More...

Inheritance diagram for SRFFreestreamVelocityFvPatchVectorField:

[legend]

Collaboration diagram for SRFFreestreamVelocityFvPatchVectorField:

[legend]

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

	SRFFreestreamVelocityFvPatchVectorField (const fvPatch &, const DimensionedField< vector, volMesh > &)
	Construct from patch and internal field. More...

	SRFFreestreamVelocityFvPatchVectorField (const fvPatch &, const DimensionedField< vector, volMesh > &, const dictionary &)
	Construct from patch, internal field and dictionary. More...

	SRFFreestreamVelocityFvPatchVectorField (const SRFFreestreamVelocityFvPatchVectorField &, const fvPatch &, const DimensionedField< vector, volMesh > &, const fvPatchFieldMapper &)
	Construct by mapping given SRFFreestreamVelocityFvPatchVectorField. More...

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

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

	SRFFreestreamVelocityFvPatchVectorField (const SRFFreestreamVelocityFvPatchVectorField &, 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...

const vector &	UInf () const
	Return the velocity at infinity. More...

vector &	UInf ()
	Return reference to the velocity at infinity to allow adjustment. More...

virtual void	updateCoeffs ()
	Update the coefficients associated with the patch field. More...

virtual void	write (Ostream &) const
	Write. More...

Private Attributes
Switch	relative_
	Is the supplied inlet value relative to the SRF. More...

vector	UInf_
	Velocity of the free stream in the absolute frame [m/s]. More...

Detailed Description

Freestream velocity condition to be used in conjunction with the single rotating frame (SRF) model (see: SRFModel class)

Given the free stream velocity in the absolute frame, the condition applies the appropriate rotation transformation in time and space to determine the local velocity using:

$U_p = cos(\theta) U_{Inf} + sin(\theta) (n \times U_{Inf}) - U_{p,srf}$

where

	=	patch velocity [m/s]
$U_{Inf}$	=	free stream velocity in the absolute frame [m/s]
$\theta$	=	swept angle [rad]
	=	axis direction of the SRF
$U_{p,srf}$	=	SRF velocity of the patch [m/s]

Patch usage

Property	Description	Required	Default value
`UInf`	freestream velocity	yes
`relative`	UInf relative to the SRF?	no

Example of the boundary condition specification:

    myPatch
    {
        type            SRFFreestreamVelocity;
        UInf            uniform (0 0 0);
        relative        no;
        value           uniform (0 0 0);    // initial value
    }

See also: Foam::freestreamFvPatchField Foam::SRFVelocityFvPatchVectorField

Source files

Definition at line 126 of file SRFFreestreamVelocityFvPatchVectorField.H.

Constructor & Destructor Documentation

◆ SRFFreestreamVelocityFvPatchVectorField() [1/5]

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

Construct from patch and internal field.

Definition at line 38 of file SRFFreestreamVelocityFvPatchVectorField.C.

Referenced by SRFFreestreamVelocityFvPatchVectorField::clone().

Here is the caller graph for this function:

◆ SRFFreestreamVelocityFvPatchVectorField() [2/5]

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

Construct from patch, internal field and dictionary.

Definition at line 66 of file SRFFreestreamVelocityFvPatchVectorField.C.

References dict, p, and vectorField().

Here is the call graph for this function:

◆ SRFFreestreamVelocityFvPatchVectorField() [3/5]

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

Construct by mapping given SRFFreestreamVelocityFvPatchVectorField.

onto a new patch

Definition at line 51 of file SRFFreestreamVelocityFvPatchVectorField.C.

◆ SRFFreestreamVelocityFvPatchVectorField() [4/5]

SRFFreestreamVelocityFvPatchVectorField ( const SRFFreestreamVelocityFvPatchVectorField & srfvpvf )

Construct as copy.

Definition at line 84 of file SRFFreestreamVelocityFvPatchVectorField.C.

◆ SRFFreestreamVelocityFvPatchVectorField() [5/5]

SRFFreestreamVelocityFvPatchVectorField	(	const SRFFreestreamVelocityFvPatchVectorField &	srfvpvf,
		const DimensionedField< vector, volMesh > &	iF
	)

Construct as copy setting internal field reference.

Definition at line 96 of file SRFFreestreamVelocityFvPatchVectorField.C.

Member Function Documentation

◆ TypeName()

TypeName ( "SRFFreestreamVelocity" )

Runtime type information.

◆ clone() [1/2]

virtual tmp<fvPatchVectorField> clone ( ) const

inlinevirtual

Construct and return a clone.

Definition at line 179 of file SRFFreestreamVelocityFvPatchVectorField.H.

References SRFFreestreamVelocityFvPatchVectorField::SRFFreestreamVelocityFvPatchVectorField().

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 196 of file SRFFreestreamVelocityFvPatchVectorField.H.

References SRFFreestreamVelocityFvPatchVectorField::SRFFreestreamVelocityFvPatchVectorField().

Here is the call graph for this function:

◆ UInf() [1/2]

const vector& UInf ( ) const

inline

Return the velocity at infinity.

Definition at line 212 of file SRFFreestreamVelocityFvPatchVectorField.H.

References SRFFreestreamVelocityFvPatchVectorField::UInf_.

◆ UInf() [2/2]

vector& UInf ( )

inline

Return reference to the velocity at infinity to allow adjustment.

Definition at line 218 of file SRFFreestreamVelocityFvPatchVectorField.H.

References SRFFreestreamVelocityFvPatchVectorField::UInf_.

◆ updateCoeffs()

void updateCoeffs ( )

virtual

Update the coefficients associated with the patch field.

Definition at line 109 of file SRFFreestreamVelocityFvPatchVectorField.C.

References SRFModel::axis(), Foam::cos(), dimensionedInternalField(), Foam::mag(), mesh, Foam::name(), SRFModel::omega(), Foam::pos(), SRFFreestreamVelocityFvPatchVectorField::relative_, Foam::sin(), SRFFreestreamVelocityFvPatchVectorField::UInf_, fvPatchField< Type >::updateCoeffs(), dimensioned::value(), and SRFModel::velocity().

Here is the call graph for this function:

◆ write()

void write ( Ostream & os ) const

virtual

Write.

Definition at line 158 of file SRFFreestreamVelocityFvPatchVectorField.C.

References token::END_STATEMENT, Foam::nl, fvPatchField::write(), and Ostream::writeKeyword().

Here is the call graph for this function:

Field Documentation

◆ relative_

Switch relative_

private

Is the supplied inlet value relative to the SRF.

Definition at line 133 of file SRFFreestreamVelocityFvPatchVectorField.H.

Referenced by SRFFreestreamVelocityFvPatchVectorField::updateCoeffs().

◆ UInf_

vector UInf_

private

Velocity of the free stream in the absolute frame [m/s].

Definition at line 136 of file SRFFreestreamVelocityFvPatchVectorField.H.

Referenced by SRFFreestreamVelocityFvPatchVectorField::UInf(), and SRFFreestreamVelocityFvPatchVectorField::updateCoeffs().

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

src/finiteVolume/cfdTools/general/SRF/derivedFvPatchFields/SRFFreestreamVelocityFvPatchVectorField/SRFFreestreamVelocityFvPatchVectorField.H
src/finiteVolume/cfdTools/general/SRF/derivedFvPatchFields/SRFFreestreamVelocityFvPatchVectorField/SRFFreestreamVelocityFvPatchVectorField.C

Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ SRFFreestreamVelocityFvPatchVectorField() [1/5]

◆ SRFFreestreamVelocityFvPatchVectorField() [2/5]

◆ SRFFreestreamVelocityFvPatchVectorField() [3/5]

◆ SRFFreestreamVelocityFvPatchVectorField() [4/5]

◆ SRFFreestreamVelocityFvPatchVectorField() [5/5]

Member Function Documentation

◆ TypeName()

◆ clone() [1/2]

◆ clone() [2/2]

◆ UInf() [1/2]

◆ UInf() [2/2]

◆ updateCoeffs()

◆ write()

Field Documentation

◆ relative_

◆ UInf_