This boundary condition provides an advective outflow condition, based on solving DDt(W, field) = 0 at the boundary where W is the wave velocity and field is the field to which this boundary condition is applied. More...

Inheritance diagram for advectiveFvPatchField< Type >:

[legend]

Collaboration diagram for advectiveFvPatchField< Type >:

[legend]

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

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

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

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

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

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

	advectiveFvPatchField (const advectiveFvPatchField &, const DimensionedField< Type, volMesh > &)
	Construct as copy setting internal field reference. More...

virtual tmp< fvPatchField< Type > >	clone (const DimensionedField< Type, volMesh > &iF) const
	Construct and return a clone setting internal field reference. More...

const Type &	fieldInf () const
	Return the field at infinity. More...

Type &	fieldInf ()
	Return reference to the field at infinity to allow adjustment. More...

scalar	lInf () const
	Return the relaxation length-scale. More...

scalar &	lInf ()
	Return reference to the relaxation length-scale. More...

virtual tmp< scalarField >	advectionSpeed () const
	Calculate and return the advection speed at the boundary. More...

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

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

Public Member Functions inherited from mixedFvPatchField< Type >
	TypeName ("mixed")
	Runtime type information. More...

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

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

	mixedFvPatchField (const mixedFvPatchField< Type > &, const fvPatch &, const DimensionedField< Type, volMesh > &, const fvPatchFieldMapper &)
	Construct by mapping the given mixedFvPatchField onto a new patch. More...

	mixedFvPatchField (const mixedFvPatchField< Type > &)
	Construct as copy. More...

	mixedFvPatchField (const mixedFvPatchField< Type > &, const DimensionedField< Type, volMesh > &)
	Construct as copy setting internal field reference. More...

virtual bool	fixesValue () const
	Return true if this patch field fixes a value. More...

virtual bool	assignable () const
	Return false: this patch field is not altered by assignment. More...

virtual Field< Type > &	refValue ()

virtual const Field< Type > &	refValue () const

virtual Field< Type > &	refGrad ()

virtual const Field< Type > &	refGrad () const

virtual scalarField &	valueFraction ()

virtual const scalarField &	valueFraction () const

virtual Field< Type > &	source ()

virtual const Field< Type > &	source () const

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

virtual void	rmap (const fvPatchField< Type > &, const labelList &)
	Reverse map the given fvPatchField onto this fvPatchField. More...

virtual tmp< Field< Type > >	snGrad () const
	Return gradient at boundary. More...

virtual void	evaluate (const Pstream::commsTypes commsType=Pstream::commsTypes::blocking)
	Evaluate the patch field. More...

virtual tmp< Field< Type > >	valueInternalCoeffs (const tmp< scalarField > &) const
	Return the matrix diagonal coefficients corresponding to the. More...

virtual tmp< Field< Type > >	valueBoundaryCoeffs (const tmp< scalarField > &) const
	Return the matrix source coefficients corresponding to the. More...

virtual tmp< Field< Type > >	gradientInternalCoeffs () const
	Return the matrix diagonal coefficients corresponding to the. More...

virtual tmp< Field< Type > >	gradientBoundaryCoeffs () const
	Return the matrix source coefficients corresponding to the. More...

virtual void	operator= (const UList< Type > &)

virtual void	operator= (const fvPatchField< Type > &)

virtual void	operator+= (const fvPatchField< Type > &)

virtual void	operator-= (const fvPatchField< Type > &)

virtual void	operator*= (const fvPatchField< scalar > &)

virtual void	operator/= (const fvPatchField< scalar > &)

virtual void	operator+= (const Field< Type > &)

virtual void	operator-= (const Field< Type > &)

virtual void	operator*= (const Field< scalar > &)

virtual void	operator/= (const Field< scalar > &)

virtual void	operator= (const Type &)

virtual void	operator+= (const Type &)

virtual void	operator-= (const Type &)

virtual void	operator*= (const scalar)

virtual void	operator/= (const scalar)

Public Member Functions inherited from fvPatchField< Type >
	TypeName ("fvPatchField")
	Runtime type information. More...

	declareRunTimeSelectionTable (tmp, fvPatchField, patch,(const fvPatch &p, const DimensionedField< Type, volMesh > &iF),(p, iF))

	declareRunTimeSelectionTable (tmp, fvPatchField, patchMapper,(const fvPatchField< Type > &ptf, const fvPatch &p, const DimensionedField< Type, volMesh > &iF, const fvPatchFieldMapper &m),(dynamic_cast< const fvPatchFieldType & >(ptf), p, iF, m))

	declareRunTimeSelectionTable (tmp, fvPatchField, dictionary,(const fvPatch &p, const DimensionedField< Type, volMesh > &iF, const dictionary &dict),(p, iF, dict))

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

	fvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &, const Type &value)
	Construct from patch, internal field and value. More...

	fvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &, const word &patchType)
	Construct from patch and internal field and patch type. More...

	fvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &, const Field< Type > &)
	Construct from patch and internal field and patch field. More...

	fvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &, const dictionary &, const bool valueRequired=true)
	Construct from patch, internal field and dictionary. More...

	fvPatchField (const fvPatchField< Type > &, const fvPatch &, const DimensionedField< Type, volMesh > &, const fvPatchFieldMapper &)
	Construct by mapping the given fvPatchField onto a new patch. More...

	fvPatchField (const fvPatchField< Type > &)
	Construct as copy. More...

	fvPatchField (const fvPatchField< Type > &, const DimensionedField< Type, volMesh > &)
	Construct as copy setting internal field reference. More...

virtual	~fvPatchField ()=default
	Destructor. More...

bool	useImplicit () const noexcept
	Use implicit formulation for coupled patches only. More...

bool	useImplicit (bool on) noexcept
	Set useImplicit on/off. More...

virtual bool	coupled () const
	Return true if this patch field is coupled. More...

const objectRegistry &	db () const
	Return local objectRegistry. More...

const fvPatch &	patch () const
	Return patch. More...

const DimensionedField< Type, volMesh > &	internalField () const
	Return dimensioned internal field reference. More...

const Field< Type > &	primitiveField () const
	Return internal field reference. More...

const word &	patchType () const
	Optional patch type. More...

word &	patchType ()
	Optional patch type. More...

bool	updated () const
	Return true if the boundary condition has already been updated. More...

bool	manipulatedMatrix () const
	Return true if the matrix has already been manipulated. More...

virtual tmp< Field< Type > >	snGrad (const scalarField &deltaCoeffs) const
	Return patch-normal gradient for coupled-patches. More...

virtual void	updateWeightedCoeffs (const scalarField &weights)
	Update the coefficients associated with the patch field. More...

virtual tmp< Field< Type > >	patchInternalField () const
	Return internal field next to patch as patch field. More...

virtual void	patchInternalField (Field< Type > &) const
	Return internal field next to patch as patch field. More...

virtual tmp< Field< Type > >	patchNeighbourField () const
	Return patchField on the opposite patch of a coupled patch. More...

virtual void	initEvaluate (const Pstream::commsTypes commsType=Pstream::commsTypes::blocking)
	Initialise the evaluation of the patch field. More...

virtual tmp< Field< Type > >	valueInternalCoeffs (const tmp< Field< scalar >> &) const
	Return the matrix diagonal coefficients corresponding to the. More...

virtual tmp< Field< Type > >	valueBoundaryCoeffs (const tmp< Field< scalar >> &) const
	Return the matrix source coefficients corresponding to the. More...

virtual tmp< Field< Type > >	gradientInternalCoeffs (const scalarField &deltaCoeffs) const
	Return the matrix diagonal coefficients corresponding to the. More...

virtual tmp< Field< Type > >	gradientBoundaryCoeffs (const scalarField &deltaCoeffs) const
	Return the matrix source coefficients corresponding to the. More...

virtual void	manipulateMatrix (fvMatrix< Type > &matrix)
	Manipulate matrix. More...

virtual void	manipulateMatrix (fvMatrix< Type > &matrix, const scalarField &weights)
	Manipulate matrix with given weights. More...

virtual void	manipulateMatrix (fvMatrix< Type > &matrix, const label iMatrix, const direction cmp)
	Manipulate fvMatrix. More...

void	check (const fvPatchField< Type > &) const
	Check fvPatchField<Type> against given fvPatchField<Type> More...

virtual void	operator== (const fvPatchField< Type > &)

virtual void	operator== (const Field< Type > &)

virtual void	operator== (const Type &)

template<class Type2 >
Foam::tmp< Foam::fvPatchField< Type > >	NewCalculatedType (const fvPatchField< Type2 > &pf)

Protected Attributes
word	phiName_
	Name of the flux transporting the field. More...

word	rhoName_

Type	fieldInf_
	Field value of the far-field. More...

scalar	lInf_
	Relaxation length-scale. More...

Additional Inherited Members
Public Types inherited from fvPatchField< Type >
typedef fvPatch	Patch

typedef calculatedFvPatchField< Type >	Calculated

Static Public Member Functions inherited from fvPatchField< Type >
static tmp< fvPatchField< Type > >	New (const word &, const fvPatch &, const DimensionedField< Type, volMesh > &)
	Return a pointer to a new patchField created on freestore given. More...

static tmp< fvPatchField< Type > >	New (const word &, const word &actualPatchType, const fvPatch &, const DimensionedField< Type, volMesh > &)
	Return a pointer to a new patchField created on freestore given. More...

static tmp< fvPatchField< Type > >	New (const fvPatchField< Type > &, const fvPatch &, const DimensionedField< Type, volMesh > &, const fvPatchFieldMapper &)
	Return a pointer to a new patchField created on freestore from. More...

static tmp< fvPatchField< Type > >	New (const fvPatch &, const DimensionedField< Type, volMesh > &, const dictionary &)
	Return a pointer to a new patchField created on freestore. More...

static tmp< fvPatchField< Type > >	NewCalculatedType (const fvPatch &)
	Return a pointer to a new calculatedFvPatchField created on. More...

template<class Type2 >
static tmp< fvPatchField< Type > >	NewCalculatedType (const fvPatchField< Type2 > &)
	Return a pointer to a new calculatedFvPatchField created on. More...

static const word &	calculatedType ()
	Return the type of the calculated for of fvPatchField. More...

Static Public Attributes inherited from fvPatchField< Type >
static int	disallowGenericFvPatchField
	Debug switch to disallow the use of genericFvPatchField. More...

Detailed Description

template<class Type>
class Foam::advectiveFvPatchField< Type >

This boundary condition provides an advective outflow condition, based on solving DDt(W, field) = 0 at the boundary where W is the wave velocity and field is the field to which this boundary condition is applied.

The standard (Euler, backward, CrankNicolson, localEuler) time schemes are supported. Additionally an optional mechanism to relax the value at the boundary to a specified far-field value is provided which is switched on by specifying the relaxation length-scale lInf and the far-field value fieldInf.

The flow/wave speed (w) at the outlet is provided by the virtual function advectionSpeed() the default implementation of which requires the name of the flux field (phi) and optionally the density (rho) if the mass-flux rather than the volumetric-flux is given.

The flow/wave speed at the outlet can be changed by deriving a specialised BC from this class and over-riding advectionSpeed() e.g. in waveTransmissiveFvPatchField the advectionSpeed() calculates and returns the flow-speed plus the acoustic wave speed creating an acoustic wave transmissive boundary condition.

Usage

Property	Description	Required	Default value
`phi`	flux field name	no	phi
`rho`	density field name	no	rho
`fieldInf`	value of field beyond patch	no
`lInf`	distance beyond patch for `fieldInf`	no

Example of the boundary condition specification:

    <patchName>
    {
        type            advective;
        phi             phi;
    }

Note: If lInf is specified, fieldInf will be required; rho is only required in the case of a mass-based flux.

Source files

Definition at line 120 of file advectiveFvPatchField.H.

Constructor & Destructor Documentation

◆ advectiveFvPatchField() [1/5]

advectiveFvPatchField	(	const fvPatch &	p,
		const DimensionedField< Type, volMesh > &	iF
	)

Construct from patch and internal field.

Definition at line 43 of file advectiveFvPatchField.C.

References Foam::Zero.

◆ advectiveFvPatchField() [2/5]

advectiveFvPatchField	(	const fvPatch &	p,
		const DimensionedField< Type, volMesh > &	iF,
		const dictionary &	dict
	)

Construct from patch, internal field and dictionary.

Definition at line 79 of file advectiveFvPatchField.C.

References dict, Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, dictionary::found(), Foam::nl, fvPatchField< Type >::operator=(), p, Foam::foamVersion::patch, dictionary::readEntry(), dictionary::readIfPresent(), and Foam::Zero.

Here is the call graph for this function:

◆ advectiveFvPatchField() [3/5]

advectiveFvPatchField	(	const advectiveFvPatchField< Type > &	,
		const fvPatch &	,
		const DimensionedField< Type, volMesh > &	,
		const fvPatchFieldMapper &
	)

Construct by mapping given advectiveFvPatchField.

onto a new patch

◆ advectiveFvPatchField() [4/5]

advectiveFvPatchField ( const advectiveFvPatchField< Type > & ptpsf )

Construct as copy.

Definition at line 126 of file advectiveFvPatchField.C.

◆ advectiveFvPatchField() [5/5]

advectiveFvPatchField	(	const advectiveFvPatchField< Type > &	ptpsf,
		const DimensionedField< Type, volMesh > &	iF
	)

Construct as copy setting internal field reference.

Definition at line 140 of file advectiveFvPatchField.C.

Member Function Documentation

◆ TypeName()

TypeName ( "advective" )

Runtime type information.

◆ clone() [1/2]

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

inlinevirtual

Construct and return a clone.

Reimplemented from mixedFvPatchField< Type >.

Reimplemented in waveTransmissiveFvPatchField< Type >, and acousticWaveTransmissiveFvPatchField< Type >.

Definition at line 182 of file advectiveFvPatchField.H.

◆ clone() [2/2]

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

inlinevirtual

Construct and return a clone setting internal field reference.

Reimplemented from mixedFvPatchField< Type >.

Reimplemented in waveTransmissiveFvPatchField< Type >, and acousticWaveTransmissiveFvPatchField< Type >.

Definition at line 199 of file advectiveFvPatchField.H.

◆ fieldInf() [1/2]

const Type& fieldInf ( ) const

inline

Return the field at infinity.

Definition at line 215 of file advectiveFvPatchField.H.

References advectiveFvPatchField< Type >::fieldInf_.

◆ fieldInf() [2/2]

Type& fieldInf ( )

inline

Return reference to the field at infinity to allow adjustment.

Definition at line 221 of file advectiveFvPatchField.H.

References advectiveFvPatchField< Type >::fieldInf_.

◆ lInf() [1/2]

scalar lInf ( ) const

inline

Return the relaxation length-scale.

Definition at line 227 of file advectiveFvPatchField.H.

References advectiveFvPatchField< Type >::lInf_.

◆ lInf() [2/2]

scalar& lInf ( )

inline

Return reference to the relaxation length-scale.

to allow adjustment

Definition at line 234 of file advectiveFvPatchField.H.

◆ advectionSpeed()

Foam::tmp< Foam::scalarField > advectionSpeed ( ) const

virtual

Calculate and return the advection speed at the boundary.

Reimplemented in waveTransmissiveFvPatchField< Type >, and acousticWaveTransmissiveFvPatchField< Type >.

Definition at line 157 of file advectiveFvPatchField.C.

References Foam::dimArea, Foam::dimDensity, Foam::dimVelocity, Foam::foamVersion::patch, and phi.

◆ updateCoeffs()

void updateCoeffs ( )

virtual

Update the coefficients associated with the patch field.

Reimplemented from fvPatchField< Type >.

Definition at line 187 of file advectiveFvPatchField.C.

References Foam::constant::atomic::alpha, GeometricField< Type, PatchField, GeoMesh >::boundaryField(), schemesLookup::ddtScheme(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, field(), k, localEulerDdt::localRDeltaT(), Foam::max(), mesh, Foam::nl, Foam::foamVersion::patch, and fvPatchField< Type >::updateCoeffs().

Here is the call graph for this function:

◆ write()

void write ( Ostream & os ) const

virtual

Write.

Reimplemented from mixedFvPatchField< Type >.

Reimplemented in waveTransmissiveFvPatchField< Type >, and acousticWaveTransmissiveFvPatchField< Type >.

Definition at line 339 of file advectiveFvPatchField.C.

References os(), fvPatchField< Type >::write(), Ostream::writeEntry(), and Ostream::writeEntryIfDifferent().

Here is the call graph for this function:

Member Data Documentation

◆ phiName_

word phiName_

protected

Name of the flux transporting the field.

Definition at line 129 of file advectiveFvPatchField.H.

◆ rhoName_

word rhoName_

protected

Name of the density field used to normalise the mass flux if necessary

Definition at line 133 of file advectiveFvPatchField.H.

◆ fieldInf_

Type fieldInf_

protected

Field value of the far-field.

Definition at line 136 of file advectiveFvPatchField.H.

Referenced by advectiveFvPatchField< Type >::fieldInf().

◆ lInf_

scalar lInf_

protected

Relaxation length-scale.

Definition at line 139 of file advectiveFvPatchField.H.

Referenced by advectiveFvPatchField< Type >::lInf().

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

src/finiteVolume/fields/fvPatchFields/derived/advective/advectiveFvPatchField.H
src/finiteVolume/fields/fvPatchFields/derived/advective/advectiveFvPatchField.C

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

template<class Type> class Foam::advectiveFvPatchField< Type >

Constructor & Destructor Documentation

◆ advectiveFvPatchField() [1/5]

◆ advectiveFvPatchField() [2/5]

◆ advectiveFvPatchField() [3/5]

◆ advectiveFvPatchField() [4/5]

◆ advectiveFvPatchField() [5/5]

Member Function Documentation

◆ TypeName()

◆ clone() [1/2]

◆ clone() [2/2]

◆ fieldInf() [1/2]

◆ fieldInf() [2/2]

◆ lInf() [1/2]

◆ lInf() [2/2]

◆ advectionSpeed()

◆ updateCoeffs()

◆ write()

Member Data Documentation

◆ phiName_

◆ rhoName_

◆ fieldInf_

◆ lInf_

template<class Type>
class Foam::advectiveFvPatchField< Type >