Repeat< Type > Class Template Reference

Function1 which repeats a given 'value' function with a given period or frequency, and with an optional shift along the x-axis. More...

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

Public Member Functions

 TypeName ("repeat")
 
 Repeat (const word &name, const unitConversions &units, const dictionary &dict)
 Construct from name and dictionary. More...
 
 Repeat (const Repeat< Type > &se)
 Copy constructor. More...
 
virtual ~Repeat ()
 Destructor. More...
 
virtual Type value (const scalar x) const
 Return value. More...
 
virtual Type integral (const scalar x1, const scalar x2) const
 Integrate between two values. More...
 
virtual void write (Ostream &os, const unitConversions &units) const
 Write data to dictionary stream. More...
 
void operator= (const Repeat< Type > &)=delete
 Disallow default bitwise assignment. More...
 
- Public Member Functions inherited from FieldFunction1< Type, Repeat< Type > >
 FieldFunction1 (const word &name)
 Construct from name. More...
 
virtual tmp< Function1< Type > > clone () const
 Construct and return a clone. More...
 
virtual ~FieldFunction1 ()
 Destructor. More...
 
virtual tmp< Field< Type > > value (const scalarField &x) const
 Return value as a function of one scalar field. More...
 
virtual tmp< Field< Type > > integral (const scalarField &x1, const scalarField &x2) const
 Integrate between two scalar fields. More...
 
- Public Member Functions inherited from Function1< Type >
 TypeName ("Function1")
 Runtime type information. More...
 
 declareRunTimeSelectionTable (autoPtr, Function1, dictionary,(const word &name, const Function1s::unitConversions &units, const dictionary &dict),(name, units, dict))
 
 declareRunTimeSelectionTable (autoPtr, Function1, Istream,(const word &name, const Function1s::unitConversions &units, Istream &is),(name, units, is))
 
 Function1 (const word &name)
 Construct from name. More...
 
 Function1 (const Function1< Type > &f1)
 Copy constructor. More...
 
virtual ~Function1 ()
 Destructor. More...
 
const wordname () const
 Return the name of the entry. More...
 
virtual bool constant () const
 Is this function guaranteed to be constant? More...
 
void operator= (const Function1< Type > &)
 Assignment. More...
 
- Public Member Functions inherited from refCount
int count () const
 Return the current reference count. More...
 
bool unique () const
 Return true if the reference count is zero. More...
 
void operator++ ()
 Increment the reference count. More...
 
void operator++ (int)
 Increment the reference count. More...
 
void operator-- ()
 Decrement the reference count. More...
 
void operator-- (int)
 Decrement the reference count. More...
 
void operator= (const refCount &)=delete
 Disallow bitwise assignment. More...
 

Additional Inherited Members

- Public Types inherited from Function1< Type >
typedef Type returnType
 
- Static Public Member Functions inherited from Function1< Type >
static autoPtr< Function1< Type > > New (const word &name, const Function1s::unitConversions &units, const dictionary &dict)
 Select from dictionary. More...
 
static autoPtr< Function1< Type > > New (const word &name, const unitConversion &xUnits, const unitConversion &valueUnits, const dictionary &dict)
 Select from dictionary. More...
 
static autoPtr< Function1< Type > > New (const word &name, const Function1s::unitConversions &units, const word &Function1Type, Istream &is)
 Select from Istream. More...
 
static autoPtr< Function1< Type > > New (const word &name, const unitConversion &xUnits, const unitConversion &valueUnits, const word &Function1Type, Istream &is)
 Select from Istream. More...
 
- Protected Member Functions inherited from refCount
 refCount ()
 Construct null initialising count to 0. More...
 
 refCount (const refCount &)=delete
 Disallow copy. More...
 
- Protected Attributes inherited from Function1< Type >
const word name_
 Name of entry. More...
 

Detailed Description

template<class Type>
class Foam::Function1s::Repeat< Type >

Function1 which repeats a given 'value' function with a given period or frequency, and with an optional shift along the x-axis.

Usage
Example:
    <name>
    {
        type    repeat;

        period  360 [CAD];

        //frequency 0.00277778 [CAD^-1]; // <-- alternative to specifying
                                         //     the period

        start   10 [CAD];                // <-- optional shift

        value
        {
            type    table;
            file    "constant/timeVsFlowRate.foam";
            units   ([ms] [m^3/s]);
        }
    }

Where:

$ Symbol $ = Description Data type Default
$ period $ = Period of repetition scalar
$ frequency $ = Frequency of repetition scalar
$ start $ = Start x coordinate scalar 0
$ value $ = Function to repeat Function1<Type>
Source files

Definition at line 114 of file Repeat.H.

Constructor & Destructor Documentation

◆ Repeat() [1/2]

Repeat ( const word name,
const unitConversions units,
const dictionary dict 
)

Construct from name and dictionary.

Definition at line 59 of file Repeat.C.

◆ Repeat() [2/2]

Repeat ( const Repeat< Type > &  se)

Copy constructor.

Definition at line 74 of file Repeat.C.

◆ ~Repeat()

~Repeat
virtual

Destructor.

Definition at line 86 of file Repeat.C.

Member Function Documentation

◆ TypeName()

TypeName ( "repeat"  )

◆ value()

Type value ( const scalar  x) const
inlinevirtual

Return value.

Implements FieldFunction1< Type, Repeat< Type > >.

Definition at line 31 of file RepeatI.H.

References n, and x.

◆ integral()

Type integral ( const scalar  x1,
const scalar  x2 
) const
inlinevirtual

Integrate between two values.

Implements FieldFunction1< Type, Repeat< Type > >.

Definition at line 40 of file RepeatI.H.

◆ write()

void write ( Ostream os,
const unitConversions units 
) const
virtual

Write data to dictionary stream.

Implements Function1< Type >.

Definition at line 93 of file Repeat.C.

References Foam::units(), Foam::Function1s::writeEntry(), and Foam::writeEntryIfDifferent().

Here is the call graph for this function:

◆ operator=()

void operator= ( const Repeat< Type > &  )
delete

Disallow default bitwise assignment.


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