Public Member Functions | List of all members
Sine< Type > Class Template Reference

Templated sine function with support for an offset level. More...

Inheritance diagram for Sine< Type >:
Inheritance graph
[legend]
Collaboration diagram for Sine< Type >:
Collaboration graph
[legend]

Public Member Functions

 TypeName ("sine")
 
 Sine (const word &entryName, const dictionary &dict)
 Construct from entry name and dictionary. More...
 
 Sine (const Sine< Type > &se)
 Copy constructor. More...
 
virtual ~Sine ()
 Destructor. More...
 
virtual Type value (const scalar t) const
 Return value for time t. More...
 
virtual void writeData (Ostream &os) const
 Write in dictionary format. More...
 
- Public Member Functions inherited from Function1< Type >
 TypeName ("Function1") declareRunTimeSelectionTable(autoPtr
 Runtime type information. More...
 
 Function1 (const word &entryName)
 Construct from entry name. More...
 
 Function1 (const Function1< Type > &f1)
 Copy constructor. More...
 
virtual tmp< Function1< Type > > clone () const =0
 Construct and return a clone. More...
 
virtual ~Function1 ()
 Destructor. More...
 
const wordname () const
 Return the name of the entry. More...
 
virtual void convertTimeBase (const Time &t)
 Convert time. More...
 
virtual tmp< Field< Type > > value (const scalarField &x) const =0
 Return value as a function of (scalar) independent variable. More...
 
virtual Type integrate (const scalar x1, const scalar x2) const
 Integrate between two (scalar) values. More...
 
virtual tmp< Field< Type > > integrate (const scalarField &x1, const scalarField &x2) const =0
 Integrate between two (scalar) values. 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...
 

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 &entryName, const dictionary &dict)
 Selector. More...
 
- Public Attributes inherited from Function1< Type >
 Function1
 
 dictionary
 
const wordentryName
 
const word const dictionarydict
 
const word const dictionary entryName
 
const word const dictionary dict
 
- Protected Member Functions inherited from refCount
 refCount ()
 Construct null initializing count to 0. More...
 
- Protected Attributes inherited from Function1< Type >
const word name_
 Name of entry. More...
 

Detailed Description

template<class Type>
class Foam::Function1Types::Sine< Type >

Templated sine function with support for an offset level.

\[ a sin(2 \pi f (t - t_0)) s + l \]

where

$ symbol $ = Description Data type
$ a $ = Amplitude Function1<scalar>
$ f $ = Frequency [1/s] Function1<scalar>
$ s $ = Type scale factor Function1<Type>
$ l $ = Type offset level Function1<Type>
$ t_0 $ = Start time [s] scalar
$ t $ = Time [s] scalar

Example for a scalar:

        <entryName> sine;
        <entryName>Coeffs
        {
            frequency 10;
            amplitude 0.1;
            scale     2e-6;
            level     2e-6;
        }

Example for a vector:

        <entryName> sine;
        <entryName>Coeffs
        {
            frequency 10;
            amplitude 1;
            scale     (1 0.1 0);
            level     (10 1 0);
        }
Source files

Definition at line 126 of file Sine.H.

Constructor & Destructor Documentation

◆ Sine() [1/2]

Sine ( const word entryName,
const dictionary dict 
)

Construct from entry name and dictionary.

Definition at line 43 of file Sine.C.

References Foam::blockMeshTools::read().

Here is the call graph for this function:

◆ Sine() [2/2]

Sine ( const Sine< Type > &  se)

Copy constructor.

Definition at line 55 of file Sine.C.

◆ ~Sine()

~Sine ( )
virtual

Destructor.

Definition at line 69 of file Sine.C.

Member Function Documentation

◆ TypeName()

TypeName ( "sine"  )

◆ value()

Type value ( const scalar  t) const
inlinevirtual

Return value for time t.

Reimplemented from Function1< Type >.

Definition at line 32 of file SineI.H.

References Foam::sin(), Foam::constant::mathematical::twoPi(), and dimensioned< Type >::value().

Here is the call graph for this function:

◆ writeData()

void writeData ( Ostream os) const
virtual

Write in dictionary format.

Reimplemented from Function1< Type >.

Definition at line 76 of file Sine.C.

References token::BEGIN_BLOCK, Foam::decrIndent(), token::END_BLOCK, token::END_STATEMENT, Foam::endl(), Foam::incrIndent(), Foam::indent(), Function1< Type >::name(), Foam::nl, Function1< Type >::writeData(), and Ostream::writeKeyword().

Here is the call graph for this function:

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