This boundary condition provides an oscillating condition in terms of amplitude and frequency. More...

Inheritance diagram for oscillatingFixedValueFvPatchField< Type >:

Collaboration diagram for oscillatingFixedValueFvPatchField< Type >:

[legend]

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

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

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

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

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

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

	oscillatingFixedValueFvPatchField (const oscillatingFixedValueFvPatchField< Type > &, 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 Field< Type > &	refValue () const
	Return the ref value. More...

Field< Type > &	refValue ()
	Return reference to the ref value to allow adjustment. More...

scalar	amplitude () const
	Return amplitude. More...

scalar &	amplitude ()

scalar	frequency () const
	Return frequency. More...

scalar &	frequency ()

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 void	updateCoeffs ()
	Update the coefficients associated with the patch field. More...

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

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

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

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

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

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

	fixedValueFvPatchField (const fixedValueFvPatchField< 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 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 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=false)
	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 tmp< fvPatchField< Type > >	clone () const
	Construct and return a clone. More...

Foam::tmp< Foam::fvPatchField< Type > >	NewCalculatedType (const fvPatch &p)

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

virtual	~fvPatchField ()
	Destructor. More...

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

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

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

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

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

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

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

virtual bool	coupled () const
	Return true if this patch field is coupled. 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
	Return patch-normal gradient. More...

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

virtual void	updateCoeffs (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::blocking)
	Initialise the evaluation of the patch field. More...

virtual void	evaluate (const Pstream::commsTypes commsType=Pstream::blocking)
	Evaluate the patch field, sets Updated to false. More...

virtual tmp< Field< Type > >	gradientInternalCoeffs () const
	Return the matrix diagonal 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
	Return the matrix source 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...

void	writeEntryIfDifferent (Ostream &os, const word &entryName, const EntryType &value1, const EntryType &value2) const
	Helper function to write the keyword and entry only if the. 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 &)

Private Member Functions
scalar	currentScale () const
	Return current scale. More...

Private Attributes
Field< Type >	refValue_
	Reference value. More...

Type	offset_
	Offset. More...

autoPtr< DataEntry< scalar > >	amplitude_
	Amplitude. More...

autoPtr< DataEntry< scalar > >	frequency_
	Frequency. More...

label	curTimeIndex_
	Current time index. More...

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

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

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::oscillatingFixedValueFvPatchField< Type >

This boundary condition provides an oscillating condition in terms of amplitude and frequency.

$x_p = (1 + a sin(2 \pi f t))x_{ref} + x_o$

where

	=	patch values
$x_{ref}$	=	patch reference values
	=	patch offset values
	=	amplitude
	=	frequency [1/s]
	=	time [s]

Patch usage

Property	Description	Required	Default value
`refValue`	reference value	yes
`offset`	offset value	no	0.0
`amplitude`	oscillation amplitude	yes
`frequency`	oscillation frequency	yes

Example of the boundary condition specification:

    myPatch
    {
        type            oscillatingFixedValue;
        refValue        uniform 5.0;
        offset          0.0;
        amplitude       constant 0.5;
        frequency       constant 10;
    }

Note: The amplitude and frequency entries are DataEntry types, able to describe time varying functions. The example above gives the usage for supplying constant values.

See also: Foam::DataEntry

Source files

Definition at line 149 of file oscillatingFixedValueFvPatchField.H.

Constructor & Destructor Documentation

◆ oscillatingFixedValueFvPatchField() [1/5]

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

Construct from patch and internal field.

Definition at line 51 of file oscillatingFixedValueFvPatchField.C.

◆ oscillatingFixedValueFvPatchField() [2/5]

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

Construct from patch, internal field and dictionary.

Definition at line 85 of file oscillatingFixedValueFvPatchField.C.

References dict, dictionary::found(), and p.

Here is the call graph for this function:

◆ oscillatingFixedValueFvPatchField() [3/5]

oscillatingFixedValueFvPatchField	(	const oscillatingFixedValueFvPatchField< Type > &	ptf,
		const fvPatch &	p,
		const DimensionedField< Type, volMesh > &	iF,
		const fvPatchFieldMapper &	mapper
	)

Construct by mapping given oscillatingFixedValueFvPatchField.

onto a new patch

Definition at line 67 of file oscillatingFixedValueFvPatchField.C.

◆ oscillatingFixedValueFvPatchField() [4/5]

oscillatingFixedValueFvPatchField ( const oscillatingFixedValueFvPatchField< Type > & ptf )

Construct as copy.

Definition at line 118 of file oscillatingFixedValueFvPatchField.C.

◆ oscillatingFixedValueFvPatchField() [5/5]

oscillatingFixedValueFvPatchField	(	const oscillatingFixedValueFvPatchField< Type > &	ptf,
		const DimensionedField< Type, volMesh > &	iF
	)

Construct as copy setting internal field reference.

Definition at line 133 of file oscillatingFixedValueFvPatchField.C.

Member Function Documentation

◆ currentScale()

scalar currentScale

private

Return current scale.

Definition at line 37 of file oscillatingFixedValueFvPatchField.C.

References f(), Foam::sin(), and Foam::constant::mathematical::twoPi().

Here is the call graph for this function:

◆ TypeName()

TypeName ( "oscillatingFixedValue" )

Runtime type information.

◆ clone() [1/2]

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

inlinevirtual

Construct and return a clone.

Reimplemented from fixedValueFvPatchField< Type >.

Definition at line 217 of file oscillatingFixedValueFvPatchField.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 fixedValueFvPatchField< Type >.

Definition at line 234 of file oscillatingFixedValueFvPatchField.H.

◆ refValue() [1/2]

const Field<Type>& refValue ( ) const

inline

Return the ref value.

Definition at line 250 of file oscillatingFixedValueFvPatchField.H.

References oscillatingFixedValueFvPatchField< Type >::refValue_.

◆ refValue() [2/2]

Field<Type>& refValue ( )

inline

Return reference to the ref value to allow adjustment.

Definition at line 256 of file oscillatingFixedValueFvPatchField.H.

References oscillatingFixedValueFvPatchField< Type >::refValue_.

◆ amplitude() [1/2]

scalar amplitude ( ) const

inline

Return amplitude.

Definition at line 262 of file oscillatingFixedValueFvPatchField.H.

References oscillatingFixedValueFvPatchField< Type >::amplitude_.

◆ amplitude() [2/2]

scalar& amplitude ( )

inline

Definition at line 267 of file oscillatingFixedValueFvPatchField.H.

References oscillatingFixedValueFvPatchField< Type >::amplitude_.

◆ frequency() [1/2]

scalar frequency ( ) const

inline

Return frequency.

Definition at line 273 of file oscillatingFixedValueFvPatchField.H.

References oscillatingFixedValueFvPatchField< Type >::frequency_.

◆ frequency() [2/2]

scalar& frequency ( )

inline

Definition at line 278 of file oscillatingFixedValueFvPatchField.H.

References oscillatingFixedValueFvPatchField< Type >::frequency_.

◆ autoMap()

void autoMap ( const fvPatchFieldMapper & m )

virtual

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

Reimplemented from fvPatchField< Type >.

Definition at line 151 of file oscillatingFixedValueFvPatchField.C.

References fvPatchField< Type >::autoMap().

Here is the call graph for this function:

◆ rmap()

void rmap	(	const fvPatchField< Type > &	ptf,
		const labelList &	addr
	)

virtual

Reverse map the given fvPatchField onto this fvPatchField.

Reimplemented from fvPatchField< Type >.

Definition at line 162 of file oscillatingFixedValueFvPatchField.C.

References oscillatingFixedValueFvPatchField< Type >::refValue_, oscillatingFixedValueFvPatchField< Type >::rmap(), and fvPatchField< Type >::rmap().

Referenced by oscillatingFixedValueFvPatchField< Type >::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.

Reimplemented from fvPatchField< Type >.

Definition at line 177 of file oscillatingFixedValueFvPatchField.C.

References timeIndex, and fvPatchField< Type >::updateCoeffs().

Here is the call graph for this function:

◆ write()

void write ( Ostream & os ) const

virtual

Write.

Reimplemented from fixedValueFvPatchField< Type >.

Definition at line 200 of file oscillatingFixedValueFvPatchField.C.

References token::END_STATEMENT, Foam::nl, fixedValueFvPatchField< Type >::write(), and Ostream::writeKeyword().

Here is the call graph for this function:

Field Documentation

◆ refValue_

Field<Type> refValue_

private

Reference value.

Definition at line 156 of file oscillatingFixedValueFvPatchField.H.

Referenced by oscillatingFixedValueFvPatchField< Type >::refValue(), and oscillatingFixedValueFvPatchField< Type >::rmap().

◆ offset_

Type offset_

private

Offset.

Definition at line 159 of file oscillatingFixedValueFvPatchField.H.

◆ amplitude_

autoPtr<DataEntry<scalar> > amplitude_

private

Amplitude.

Definition at line 162 of file oscillatingFixedValueFvPatchField.H.

Referenced by oscillatingFixedValueFvPatchField< Type >::amplitude().

◆ frequency_

autoPtr<DataEntry<scalar> > frequency_

private

Frequency.

Definition at line 165 of file oscillatingFixedValueFvPatchField.H.

Referenced by oscillatingFixedValueFvPatchField< Type >::frequency().

◆ curTimeIndex_

label curTimeIndex_

private

Current time index.

Definition at line 168 of file oscillatingFixedValueFvPatchField.H.

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

src/finiteVolume/fields/fvPatchFields/derived/oscillatingFixedValue/oscillatingFixedValueFvPatchField.H
src/finiteVolume/fields/fvPatchFields/derived/oscillatingFixedValue/oscillatingFixedValueFvPatchField.C

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

template<class Type> class Foam::oscillatingFixedValueFvPatchField< Type >

Constructor & Destructor Documentation

◆ oscillatingFixedValueFvPatchField() [1/5]

◆ oscillatingFixedValueFvPatchField() [2/5]

◆ oscillatingFixedValueFvPatchField() [3/5]

◆ oscillatingFixedValueFvPatchField() [4/5]

◆ oscillatingFixedValueFvPatchField() [5/5]

Member Function Documentation

◆ currentScale()

◆ TypeName()

◆ clone() [1/2]

◆ clone() [2/2]

◆ refValue() [1/2]

◆ refValue() [2/2]

◆ amplitude() [1/2]

◆ amplitude() [2/2]

◆ frequency() [1/2]

◆ frequency() [2/2]

◆ autoMap()

◆ rmap()

◆ updateCoeffs()

◆ write()

Field Documentation

◆ refValue_

◆ offset_

◆ amplitude_

◆ frequency_

◆ curTimeIndex_

template<class Type>
class Foam::oscillatingFixedValueFvPatchField< Type >