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

Inheritance diagram for SRFVelocityFvPatchVectorField:

[legend]

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

Detailed Description

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

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^UInf) - U_{p,srf}$

where

	=
$U_{Inf} = free stream velocity in the absolute frame [m/s]$	=
	=
	=
$U_{p,srf} = SRF velocity of the patch$	=

Usage

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

Example of the boundary condition specification:

    <patchName>
    {
        type            SRFFreestreamVelocity;
        UInf            uniform (0 0 0);
        relative        no;
        value           uniform (0 0 0);    // initial value
    }

See also: Foam::freestreamFvPatchField Foam::SRFVelocityFvPatchVectorField

Source files

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

	=
$U_{in} = user-specified inlet velocity$	=
$U_{p,srf} = SRF velocity$	=

Usage

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

Example of the boundary condition specification:

    <patchName>
    {
        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 126 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(), and SRFVelocityFvPatchVectorField::SRFVelocityFvPatchVectorField().

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 SRFVelocityFvPatchVectorField::SRFVelocityFvPatchVectorField().

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.

References SRFVelocityFvPatchVectorField::SRFVelocityFvPatchVectorField().

Here is the call graph for this function:

◆ SRFVelocityFvPatchVectorField() [4/5]

SRFVelocityFvPatchVectorField ( const SRFVelocityFvPatchVectorField & srfvpvf )

Construct as copy.

Definition at line 74 of file SRFVelocityFvPatchVectorField.C.

References SRFVelocityFvPatchVectorField::SRFVelocityFvPatchVectorField().

Here is the call graph for this function:

◆ SRFVelocityFvPatchVectorField() [5/5]

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

Construct as copy setting internal field reference.

Definition at line 85 of file SRFVelocityFvPatchVectorField.C.

References SRFVelocityFvPatchVectorField::autoMap().

Here is the call graph for this function:

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 179 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 196 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 212 of file SRFVelocityFvPatchVectorField.H.

References SRFVelocityFvPatchVectorField::autoMap(), SRFVelocityFvPatchVectorField::rmap(), SRFVelocityFvPatchVectorField::updateCoeffs(), and SRFVelocityFvPatchVectorField::write().

Referenced by SRFModel::Uabs().

Here is the call graph for this function:

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 99 of file SRFVelocityFvPatchVectorField.C.

References SRFVelocityFvPatchVectorField::rmap().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ rmap()

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

virtual

Reverse map the given fvPatchField onto this fvPatchField.

Definition at line 109 of file SRFVelocityFvPatchVectorField.C.

References SRFVelocityFvPatchVectorField::rmap().

Referenced by SRFVelocityFvPatchVectorField::autoMap(), SRFVelocityFvPatchVectorField::relative(), and SRFVelocityFvPatchVectorField::rmap().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ updateCoeffs()

void updateCoeffs ( )

virtual

Update the coefficients associated with the patch field.

Definition at line 123 of file SRFVelocityFvPatchVectorField.C.

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

Referenced by SRFVelocityFvPatchVectorField::relative().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ write()

void write ( Ostream & os ) const

virtual

Write.

Definition at line 153 of file SRFVelocityFvPatchVectorField.C.

References token::END_STATEMENT, Foam::makePatchTypeField(), Foam::nl, fvPatchField< Type >::write(), Field< Type >::writeEntry(), and Ostream::writeKeyword().

Referenced by SRFVelocityFvPatchVectorField::relative().

Here is the call graph for this function:

Here is the caller graph for this function:

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

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