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

Inheritance diagram for SRFVelocityFvPatchVectorField:

Collaboration diagram for SRFVelocityFvPatchVectorField:

[legend]

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

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

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

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

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

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

	SRFVelocityFvPatchVectorField (const SRFVelocityFvPatchVectorField &, 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 Switch &	relative () const
	Return const access to the relative flag. More...

virtual void	autoMap (const fvPatchFieldMapper &)
	Map (and resize as needed) from self given a mapping object. More...

virtual void	rmap (const fvPatchVectorField &, const labelList &)
	Reverse map the given fvPatchField onto this fvPatchField. 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...

vectorField	inletValue_
	Inlet value [m/s]. More...

Detailed Description

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.

The optional relative flag switches the behaviour of the patch such that:

relative = yes: inlet velocity applied 'as is':

$U_p = U_{in}$

relative = no : SRF velocity is subtracted from the inlet velocity:

$U_p = U_{in} - U_{p,srf}$

where

	=	patch velocity [m/s]
$U_{in}$	=	user-specified inlet velocity
$U_{p,srf}$	=	SRF velocity

Patch usage

Property	Description	Required	Default value
`inletValue`	inlet velocity	yes
`relative`	inletValue relative motion to the SRF?	yes

Example of the boundary condition specification:

    myPatch
    {
        type            SRFVelocity;
        inletValue      uniform (0 0 0);
        relative        yes;
        value           uniform (0 0 0);    // initial value
    }

See also: Foam::fixedValueFvPatchField

Source files

Definition at line 130 of file SRFVelocityFvPatchVectorField.H.

Constructor & Destructor Documentation

◆ SRFVelocityFvPatchVectorField() [1/5]

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

Construct from patch and internal field.

Definition at line 35 of file SRFVelocityFvPatchVectorField.C.

Referenced by SRFVelocityFvPatchVectorField::clone().

Here is the caller graph for this function:

◆ SRFVelocityFvPatchVectorField() [2/5]

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

Construct from patch, internal field and dictionary.

Definition at line 61 of file SRFVelocityFvPatchVectorField.C.

References dict, p, and vectorField().

Here is the call graph for this function:

◆ SRFVelocityFvPatchVectorField() [3/5]

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

Construct by mapping given SRFVelocityFvPatchVectorField.

onto a new patch

Definition at line 47 of file SRFVelocityFvPatchVectorField.C.

◆ SRFVelocityFvPatchVectorField() [4/5]

SRFVelocityFvPatchVectorField ( const SRFVelocityFvPatchVectorField & srfvpvf )

Construct as copy.

Definition at line 76 of file SRFVelocityFvPatchVectorField.C.

◆ SRFVelocityFvPatchVectorField() [5/5]

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

Construct as copy setting internal field reference.

Definition at line 87 of file SRFVelocityFvPatchVectorField.C.

Member Function Documentation

◆ TypeName()

TypeName ( "SRFVelocity" )

Runtime type information.

◆ clone() [1/2]

virtual tmp<fvPatchVectorField> clone ( ) const

inlinevirtual

Construct and return a clone.

Definition at line 183 of file SRFVelocityFvPatchVectorField.H.

References SRFVelocityFvPatchVectorField::SRFVelocityFvPatchVectorField().

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 200 of file SRFVelocityFvPatchVectorField.H.

References SRFVelocityFvPatchVectorField::SRFVelocityFvPatchVectorField().

Here is the call graph for this function:

◆ relative()

const Switch& relative ( ) const

inline

Return const access to the relative flag.

Definition at line 216 of file SRFVelocityFvPatchVectorField.H.

References SRFVelocityFvPatchVectorField::relative_.

Referenced by SRFModel::Uabs().

Here is the caller graph for this function:

◆ autoMap()

void autoMap ( const fvPatchFieldMapper & m )

virtual

Map (and resize as needed) from self given a mapping object.

Definition at line 101 of file SRFVelocityFvPatchVectorField.C.

◆ rmap()

void rmap	(	const fvPatchVectorField &	ptf,
		const labelList &	addr
	)

virtual

Reverse map the given fvPatchField onto this fvPatchField.

Definition at line 111 of file SRFVelocityFvPatchVectorField.C.

References SRFVelocityFvPatchVectorField::inletValue_.

◆ updateCoeffs()

void updateCoeffs ( )

virtual

Update the coefficients associated with the patch field.

Definition at line 125 of file SRFVelocityFvPatchVectorField.C.

References SRFVelocityFvPatchVectorField::inletValue_, Foam::operator==(), SRFVelocityFvPatchVectorField::relative_, and SRFModel::velocity().

Here is the call graph for this function:

◆ write()

void write ( Ostream & os ) const

virtual

Write.

Definition at line 155 of file SRFVelocityFvPatchVectorField.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 137 of file SRFVelocityFvPatchVectorField.H.

Referenced by SRFVelocityFvPatchVectorField::relative(), and SRFVelocityFvPatchVectorField::updateCoeffs().

◆ inletValue_

vectorField inletValue_

private

Inlet value [m/s].

Definition at line 140 of file SRFVelocityFvPatchVectorField.H.

Referenced by SRFVelocityFvPatchVectorField::rmap(), and SRFVelocityFvPatchVectorField::updateCoeffs().

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

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

Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ SRFVelocityFvPatchVectorField() [1/5]

◆ SRFVelocityFvPatchVectorField() [2/5]

◆ SRFVelocityFvPatchVectorField() [3/5]

◆ SRFVelocityFvPatchVectorField() [4/5]

◆ SRFVelocityFvPatchVectorField() [5/5]

Member Function Documentation

◆ TypeName()

◆ clone() [1/2]

◆ clone() [2/2]

◆ relative()

◆ autoMap()

◆ rmap()

◆ updateCoeffs()

◆ write()

Field Documentation

◆ relative_

◆ inletValue_