OpenFOAM logo
Open Source CFD Toolkit

oscillatingFixedValueFvPatchField Class Template Reference

Inheritance diagram for oscillatingFixedValueFvPatchField:

Inheritance graph
[legend]
Collaboration diagram for oscillatingFixedValueFvPatchField:

Collaboration graph
[legend]
List of all members.

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


Public Member Functions

 TypeName ("oscillatingFixedValue")
 Runtime type information.
 oscillatingFixedValueFvPatchField (const fvPatch &, const Field< Type > &)
 Construct from patch and internal field.
 oscillatingFixedValueFvPatchField (const fvPatch &, const Field< Type > &, const dictionary &)
 Construct from patch, internal field and dictionary.
 oscillatingFixedValueFvPatchField (const oscillatingFixedValueFvPatchField< Type > &, const fvPatch &, const Field< Type > &, const fvPatchFieldMapper &)
 Construct by mapping given oscillatingFixedValueFvPatchField.
virtual tmp< fvPatchField<
Type > > 
clone () const
 Construct and return a clone.
 oscillatingFixedValueFvPatchField (const oscillatingFixedValueFvPatchField< Type > &, const Field< Type > &)
 Construct as copy setting internal field reference.
virtual tmp< fvPatchField<
Type > > 
clone (const Field< Type > &iF) const
 Construct and return a clone setting internal field reference.
const Field< Type > & refValue () const
 Return the ref value.
Field< Type > & refValue ()
 Return reference to the ref value to allow adjustment.
scalar amplitude () const
 Return amplitude.
scalar & amplitude ()
scalar frequency () const
 Return frequency.
scalar & frequency ()
virtual void autoMap (const fvPatchFieldMapper &)
 Map (and resize as needed) from self given a mapping object.
virtual void rmap (const fvPatchField< Type > &, const labelList &)
 Reverse map the given fvPatchField onto this fvPatchField.
virtual void updateCoeffs ()
 Update the coefficients associated with the patch field.
virtual void write (Ostream &) const
 Write.

Constructor & Destructor Documentation

oscillatingFixedValueFvPatchField const fvPatch ,
const Field< Type > & 
 

Construct from patch and internal field.

oscillatingFixedValueFvPatchField const fvPatch ,
const Field< Type > &  ,
const dictionary
 

Construct from patch, internal field and dictionary.

oscillatingFixedValueFvPatchField const oscillatingFixedValueFvPatchField< Type > &  ,
const fvPatch ,
const Field< Type > &  ,
const fvPatchFieldMapper
 

Construct by mapping given oscillatingFixedValueFvPatchField.

onto a new patch

oscillatingFixedValueFvPatchField const oscillatingFixedValueFvPatchField< Type > &  ,
const Field< Type > & 
 

Construct as copy setting internal field reference.


Member Function Documentation

scalar& amplitude  )  [inline]
 

Definition at line 166 of file oscillatingFixedValueFvPatchField.H.

scalar amplitude  )  const [inline]
 

Return amplitude.

Definition at line 161 of file oscillatingFixedValueFvPatchField.H.

virtual void autoMap const fvPatchFieldMapper  )  [virtual]
 

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

Reimplemented from fvPatchField.

virtual tmp<fvPatchField<Type> > clone const Field< Type > &  iF  )  const [inline, virtual]
 

Construct and return a clone setting internal field reference.

Reimplemented from fixedValueFvPatchField.

Definition at line 135 of file oscillatingFixedValueFvPatchField.H.

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

Construct and return a clone.

Reimplemented from fixedValueFvPatchField.

Definition at line 119 of file oscillatingFixedValueFvPatchField.H.

scalar& frequency  )  [inline]
 

Definition at line 177 of file oscillatingFixedValueFvPatchField.H.

References Foam::labelList.

scalar frequency  )  const [inline]
 

Return frequency.

Definition at line 172 of file oscillatingFixedValueFvPatchField.H.

Field<Type>& refValue  )  [inline]
 

Return reference to the ref value to allow adjustment.

Definition at line 155 of file oscillatingFixedValueFvPatchField.H.

const Field<Type>& refValue  )  const [inline]
 

Return the ref value.

Definition at line 149 of file oscillatingFixedValueFvPatchField.H.

virtual void rmap const fvPatchField< Type > &  ,
const labelList
[virtual]
 

Reverse map the given fvPatchField onto this fvPatchField.

Reimplemented from fvPatchField.

TypeName "oscillatingFixedValue"   ) 
 

Runtime type information.

virtual void updateCoeffs  )  [virtual]
 

Update the coefficients associated with the patch field.

Reimplemented from fvPatchField.

virtual void write Ostream  )  const [virtual]
 

Write.

Reimplemented from fixedValueFvPatchField.


The documentation for this class was generated from the following file:
For further information go to www.openfoam.org