A time-varying form of a uniform fixed value boundary condition. More...

#include <finiteVolume/timeVaryingUniformInletOutletFvPatchField.H>

Detailed Description

template<class Type>
class Foam::timeVaryingUniformInletOutletFvPatchField< Type >

A time-varying form of a uniform fixed value boundary condition.

Example of the boundary condition specification:

inlet
{
typetimeVaryingUniformInletOutlet;
fileName"$FOAM_CASE/time-series";
outOfBounds clamp;   // (error|warn|clamp|repeat)
}

Note:: This class is derived directly from a inletOutlet patch rather than from a uniformInletOutlet patch.

See also:: Foam::interpolationTable and Foam::inletOutletFvPatchField

Source files

Definition at line 68 of file timeVaryingUniformInletOutletFvPatchField.H.

Inheritance diagram for timeVaryingUniformInletOutletFvPatchField< Type >:

Collaboration diagram for timeVaryingUniformInletOutletFvPatchField< Type >:

List of all members.

Public Member Functions
	TypeName ("timeVaryingUniformInletOutlet")
	Runtime type information.
	timeVaryingUniformInletOutletFvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &)
	Construct from patch and internal field.
	timeVaryingUniformInletOutletFvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &, const dictionary &)
	Construct from patch, internal field and dictionary.
	timeVaryingUniformInletOutletFvPatchField (const timeVaryingUniformInletOutletFvPatchField< Type > &, const fvPatch &, const DimensionedField< Type, volMesh > &, const fvPatchFieldMapper &)
	Construct by mapping given patch field onto a new patch.
	timeVaryingUniformInletOutletFvPatchField (const timeVaryingUniformInletOutletFvPatchField< Type > &)
	Construct as copy.
virtual tmp< fvPatchField< Type > >	clone () const
	Construct and return a clone.
	timeVaryingUniformInletOutletFvPatchField (const timeVaryingUniformInletOutletFvPatchField< Type > &, const DimensionedField< Type, volMesh > &)
	Construct as copy setting internal field reference.
virtual tmp< fvPatchField< Type > >	clone (const DimensionedField< Type, volMesh > &iF) const
	Construct and return a clone setting internal field reference.
const interpolationTable< Type > &	timeSeries () const
	Return the time series used.
virtual void	updateCoeffs ()
	Update the coefficients associated with the patch field.
virtual void	write (Ostream &) const
	Write.

Constructor & Destructor Documentation

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

Construct from patch and internal field.

Definition at line 34 of file timeVaryingUniformInletOutletFvPatchField.C.

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

Construct from patch, internal field and dictionary.

Definition at line 47 of file timeVaryingUniformInletOutletFvPatchField.C.

References dictionary::found(), Foam::operator==(), and List< Type >::size().

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

Construct by mapping given patch field onto a new patch.

Definition at line 74 of file timeVaryingUniformInletOutletFvPatchField.C.

timeVaryingUniformInletOutletFvPatchField ( const timeVaryingUniformInletOutletFvPatchField< Type > & ptf )

Construct as copy.

Definition at line 89 of file timeVaryingUniformInletOutletFvPatchField.C.

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

Construct as copy setting internal field reference.

Definition at line 101 of file timeVaryingUniformInletOutletFvPatchField.C.

Member Function Documentation

TypeName ( "timeVaryingUniformInletOutlet" )

Runtime type information.

virtual tmp<fvPatchField<Type> > clone ( ) const [inline, virtual]

Construct and return a clone.

Reimplemented from inletOutletFvPatchField< Type >.

Definition at line 117 of file timeVaryingUniformInletOutletFvPatchField.H.

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

Construct and return a clone setting internal field reference.

Reimplemented from inletOutletFvPatchField< Type >.

Definition at line 134 of file timeVaryingUniformInletOutletFvPatchField.H.

const interpolationTable<Type>& timeSeries ( ) const [inline]

Return the time series used.

Definition at line 150 of file timeVaryingUniformInletOutletFvPatchField.H.

void updateCoeffs ( ) [virtual]

Update the coefficients associated with the patch field.

Reimplemented from inletOutletFvPatchField< Type >.

Definition at line 114 of file timeVaryingUniformInletOutletFvPatchField.C.

void write ( Ostream & os ) const [virtual]

Write.

Reimplemented from inletOutletFvPatchField< Type >.

Definition at line 128 of file timeVaryingUniformInletOutletFvPatchField.C.

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

src/finiteVolume/fields/fvPatchFields/derived/timeVaryingUniformInletOutlet/timeVaryingUniformInletOutletFvPatchField.H
src/finiteVolume/fields/fvPatchFields/derived/timeVaryingUniformInletOutlet/timeVaryingUniformInletOutletFvPatchField.C

timeVaryingUniformInletOutletFvPatchField< Type > Class Template Reference

Detailed Description

template<class Type> class Foam::timeVaryingUniformInletOutletFvPatchField< Type >

Public Member Functions

Constructor & Destructor Documentation

Member Function Documentation

template<class Type>
class Foam::timeVaryingUniformInletOutletFvPatchField< Type >