waveAlphaFvPatchScalarField Class Reference

Example of the boundary condition specification: More...

#include <waveAlphaFvPatchScalarField.H>

Inheritance diagram for waveAlphaFvPatchScalarField:

Collaboration diagram for waveAlphaFvPatchScalarField:

Public Member Functions
	TypeName ("waveAlpha")
	Runtime type information.
	waveAlphaFvPatchScalarField (const fvPatch &, const DimensionedField< scalar, volMesh > &)
	Construct from patch and internal field.
	waveAlphaFvPatchScalarField (const fvPatch &, const DimensionedField< scalar, volMesh > &, const dictionary &)
	Construct from patch, internal field and dictionary.
	waveAlphaFvPatchScalarField (const waveAlphaFvPatchScalarField &, const fvPatch &, const DimensionedField< scalar, volMesh > &, const fvPatchFieldMapper &)
	Construct by mapping given.
	waveAlphaFvPatchScalarField (const waveAlphaFvPatchScalarField &)
	Construct as copy.
	waveAlphaFvPatchScalarField (const waveAlphaFvPatchScalarField &, const DimensionedField< scalar, volMesh > &)
	Construct as copy setting internal field reference.
virtual tmp< fvPatchField< scalar > >	clone () const
	Return a clone.
virtual tmp< fvPatchField< scalar > >	clone (const DimensionedField< scalar, volMesh > &iF) const
	Clone with an internal field reference.
virtual void	updateCoeffs ()
	Update the coefficients associated with the patch field.
virtual void	write (Ostream &) const
	Write.

Detailed Description

Example of the boundary condition specification:

inlet
{
    type            waveAlpha;
    value           uniform (0 0 0);
}

Usage

Property	Description	Required	Default value
type	type: waveAlpha	yes
waveDict	Dictionary specifying wave variables	no	waveProperties

Note

• The value is positive inwards
• May not work correctly for transonic inlets
• Strange behaviour with potentialFoam since the U equation is not solved

Source files

• waveAlphaFvPatchScalarField.H
• waveAlphaFvPatchScalarField.C

Definition at line 80 of file waveAlphaFvPatchScalarField.H.

Constructor & Destructor Documentation

waveAlphaFvPatchScalarField() [1/5]

waveAlphaFvPatchScalarField	(	const fvPatch &	p,
		const DimensionedField< scalar, volMesh > &	iF )

Construct from patch and internal field.

Definition at line 29 of file waveAlphaFvPatchScalarField.C.

References dictName(), and p.

Referenced by TypeName(), waveAlphaFvPatchScalarField(), waveAlphaFvPatchScalarField(), and waveAlphaFvPatchScalarField().

Here is the call graph for this function:

Here is the caller graph for this function:

waveAlphaFvPatchScalarField() [2/5]

waveAlphaFvPatchScalarField	(	const fvPatch &	p,
		const DimensionedField< scalar, volMesh > &	iF,
		const dictionary &	dict )

Construct from patch, internal field and dictionary.

Definition at line 53 of file waveAlphaFvPatchScalarField.C.

References dict, dictName(), and p.

Here is the call graph for this function:

waveAlphaFvPatchScalarField() [3/5]

waveAlphaFvPatchScalarField	(	const waveAlphaFvPatchScalarField &	ptf,
		const fvPatch &	p,
		const DimensionedField< scalar, volMesh > &	iF,
		const fvPatchFieldMapper &	mapper )

Construct by mapping given.

waveAlphaFvPatchScalarField onto a new patch

Definition at line 40 of file waveAlphaFvPatchScalarField.C.

References p, and waveAlphaFvPatchScalarField().

Here is the call graph for this function:

waveAlphaFvPatchScalarField() [4/5]

waveAlphaFvPatchScalarField

(

const waveAlphaFvPatchScalarField &

ptf

)

Construct as copy.

Definition at line 65 of file waveAlphaFvPatchScalarField.C.

References waveAlphaFvPatchScalarField().

Here is the call graph for this function:

waveAlphaFvPatchScalarField() [5/5]

waveAlphaFvPatchScalarField	(	const waveAlphaFvPatchScalarField &	ptf,
		const DimensionedField< scalar, volMesh > &	iF )

Construct as copy setting internal field reference.

Definition at line 75 of file waveAlphaFvPatchScalarField.C.

References waveAlphaFvPatchScalarField().

Here is the call graph for this function:

Member Function Documentation

TypeName()

TypeName

(

"waveAlpha"

)

Runtime type information.

References waveAlphaFvPatchScalarField().

Here is the call graph for this function:

clone() [1/2]

virtual tmp< fvPatchField< scalar > > clone ( ) const

inlinevirtual

Return a clone.

Definition at line 155 of file waveAlphaFvPatchScalarField.H.

References fvPatchField< Type >::Clone().

Here is the call graph for this function:

clone() [2/2]

virtual tmp< fvPatchField< scalar > > clone ( const DimensionedField< scalar, volMesh > & iF ) const

inlinevirtual

Clone with an internal field reference.

Definition at line 163 of file waveAlphaFvPatchScalarField.H.

References fvPatchField< Type >::Clone().

Here is the call graph for this function:

updateCoeffs()

void updateCoeffs ( )

virtual

Update the coefficients associated with the patch field.

Definition at line 88 of file waveAlphaFvPatchScalarField.C.

References waveModel::alpha(), tmp< T >::constCast(), waveModel::correct(), waveModel::lookupOrCreate(), mesh, Foam::operator==(), and fvPatchField< Type >::updateCoeffs().

Here is the call graph for this function:

write()

void write ( Ostream & os ) const

virtual

Write.

Definition at line 115 of file waveAlphaFvPatchScalarField.C.

References os(), fvPatchField< Type >::write(), and fvPatchField< Type >::writeValueEntry().

Here is the call graph for this function:

---

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

• src/waveModels/derivedFvPatchFields/waveAlpha/waveAlphaFvPatchScalarField.H
• src/waveModels/derivedFvPatchFields/waveAlpha/waveAlphaFvPatchScalarField.C