FreeFOAM The Cross-Platform CFD Toolkit
Hosted by SourceForge:
Get FreeFOAM at SourceForge.net.
            Fast, secure and Free Open Source software downloads

oscillatingFixedValueFvPatchField< Type > Class Template Reference

Foam::oscillatingFixedValueFvPatchField. More...

#include <finiteVolume/oscillatingFixedValueFvPatchField.H>


Detailed Description

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

Foam::oscillatingFixedValueFvPatchField.

Source files

Definition at line 51 of file oscillatingFixedValueFvPatchField.H.

Inheritance diagram for oscillatingFixedValueFvPatchField< Type >:
Collaboration diagram for oscillatingFixedValueFvPatchField< Type >:

List of all members.

Public Member Functions

 TypeName ("oscillatingFixedValue")
 Runtime type information.
 oscillatingFixedValueFvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &)
 Construct from patch and internal field.
 oscillatingFixedValueFvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &, const dictionary &)
 Construct from patch, internal field and dictionary.
 oscillatingFixedValueFvPatchField (const oscillatingFixedValueFvPatchField< Type > &, const fvPatch &, const DimensionedField< Type, volMesh > &, const fvPatchFieldMapper &)
 Construct by mapping given oscillatingFixedValueFvPatchField.
 oscillatingFixedValueFvPatchField (const oscillatingFixedValueFvPatchField< Type > &)
 Construct as copy.
virtual tmp< fvPatchField< Type > >  clone () const
 Construct and return a clone.
 oscillatingFixedValueFvPatchField (const oscillatingFixedValueFvPatchField< 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 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 &   p,
const DimensionedField< Type, volMesh > &   iF  
)

Construct from patch and internal field.

Definition at line 50 of file oscillatingFixedValueFvPatchField.C.

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

Construct from patch, internal field and dictionary.

Definition at line 82 of file oscillatingFixedValueFvPatchField.C.

References dictionary::found(), fvPatchField< Type >::operator==(), and fvPatch::size().

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 65 of file oscillatingFixedValueFvPatchField.C.

Construct as copy.

Definition at line 110 of file oscillatingFixedValueFvPatchField.C.

Construct as copy setting internal field reference.

Definition at line 124 of file oscillatingFixedValueFvPatchField.C.


Member Function Documentation

TypeName ( "oscillatingFixedValue"    )

Runtime type information.

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

Construct and return a clone.

Reimplemented from fixedValueFvPatchField< Type >.

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

Definition at line 133 of file oscillatingFixedValueFvPatchField.H.

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

Return the ref value.

Definition at line 149 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.

scalar amplitude (  ) const [inline]

Return amplitude.

Definition at line 161 of file oscillatingFixedValueFvPatchField.H.

scalar& amplitude (  ) [inline]

Definition at line 166 of file oscillatingFixedValueFvPatchField.H.

scalar frequency (  ) const [inline]

Return frequency.

Definition at line 172 of file oscillatingFixedValueFvPatchField.H.

scalar& frequency (  ) [inline]

Definition at line 177 of file oscillatingFixedValueFvPatchField.H.

void autoMap ( const fvPatchFieldMapper &   m  ) [virtual]

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

Reimplemented from fvPatchField< Type >.

Definition at line 141 of file oscillatingFixedValueFvPatchField.C.

References fvPatchField< Type >::autoMap().

void rmap ( const fvPatchField< Type > &   ptf,
const labelList &   addr  
) [virtual]
void updateCoeffs (  ) [virtual]

Update the coefficients associated with the patch field.

Reimplemented from fvPatchField< Type >.

Definition at line 167 of file oscillatingFixedValueFvPatchField.C.

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

void write ( Ostream &   os  ) const [virtual]

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