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 x) const
 Return value. More...
 
virtual Type integrate (const scalar x1, const scalar x2) const
 Integrate between two values. More...
 
virtual void writeData (Ostream &os) const
 Write in dictionary format. More...
 
void operator= (const Sine< Type > &)=delete
 Disallow default bitwise assignment. More...
 
- Public Member Functions inherited from FieldFunction1< Type, Sine< Type > >
 FieldFunction1 (const word &entryName)
 Construct from entry name. More...
 
 FieldFunction1 (const FieldFunction1< Type, Sine< Type > > &ff1)
 Copy constructor. 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 (scalar) independent variable. More...
 
virtual tmp< Field< Type > > integrate (const scalarField &x1, const scalarField &x2) const
 Integrate between two (scalar) values. 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 ~Function1 ()
 Destructor. More...
 
const word & name () const
 Return the name of the entry. More...
 
void operator= (const Function1< Type > &)=delete
 Disallow default bitwise 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...
 

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 word & entryName
 
const word const dictionary & dict
 
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::Function1s::Sine< Type >

Templated sine function with support for an offset level.

\[ a sin(2 \pi f (x - x_0)) + l \]

where

$ Symbol $ = Description Data type Default
$ a $ = Amplitude Function1<Type>
$ f $ = Frequency scalar
$ x_0 $ = Start scalar 0
$ l $ = Offset level Function1<Type>

Example for a scalar: 

        <entryName> sine;
        <entryName>Coeffs
        {
            amplitude 2e-7;
            frequency 10;
            start     0;
            level     2e-6;
        }

Example for a vector: 

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

Definition at line 119 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 48 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 60 of file Sine.C.

◆ ~Sine()

~Sine ( )
virtual

Destructor.

Definition at line 74 of file Sine.C.

Member Function Documentation

◆ TypeName()

TypeName ( "sine"  )

◆ value()

Type value ( const scalar  x) const
inlinevirtual

Return value.

Implements FieldFunction1< Type, Sine< Type > >.

Definition at line 32 of file SineI.H.

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

Here is the call graph for this function:

◆ integrate()

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

Integrate between two values.

Implements FieldFunction1< Type, Sine< Type > >.

Definition at line 42 of file SineI.H.

References Foam::cos(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, Foam::constant::mathematical::twoPi(), and Foam::type().

Referenced by Sine< Type >::value().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ writeData()

void writeData ( Ostream &  os) const
virtual

Write in dictionary format.

Reimplemented from Function1< Type >.

Definition at line 81 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 Foam::writeEntry().

Here is the call graph for this function:

◆ operator=()

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

Disallow default bitwise assignment.

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