Loading...
Searching...
No Matches
Sine< Type > Class Template Reference

A templated sine function, with support for offset etc. More...

#include <Sine.H>

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

Public Member Functions

 TypeName ("sine")
void operator= (const Sine< Type > &)=delete
 No copy assignment.
 Sine (const word &entryName, const dictionary &dict, const objectRegistry *obrPtr=nullptr)
 Construct from entry name, dictionary and optional registry.
 Sine (const Sine< Type > &rhs)
 Copy construct.
virtual tmp< Function1< Type > > clone () const
 Return a clone.
virtual ~Sine ()=default
 Destructor.
virtual void userTimeToTime (const Time &t)
 Convert time.
virtual Type value (const scalar t) const
 Return value for time t.
virtual Type integrate (const scalar x1, const scalar x2) const
 Integrate between two (scalar) values.
virtual void writeData (Ostream &os) const
 Write in dictionary format.
virtual void writeEntries (Ostream &os) const
 Write coefficient entries in dictionary format.
const::Foam::word typeName (Function1Types::Sine< scalar >::typeName_())
int debug (::Foam::debug::debugSwitch(Function1Types::Sine< scalar >::typeName_(), 0))
const::Foam::word typeName (Function1Types::Sine< vector >::typeName_())
int debug (::Foam::debug::debugSwitch(Function1Types::Sine< vector >::typeName_(), 0))
const::Foam::word typeName (Function1Types::Sine< sphericalTensor >::typeName_())
int debug (::Foam::debug::debugSwitch(Function1Types::Sine< sphericalTensor >::typeName_(), 0))
const::Foam::word typeName (Function1Types::Sine< symmTensor >::typeName_())
int debug (::Foam::debug::debugSwitch(Function1Types::Sine< symmTensor >::typeName_(), 0))
const::Foam::word typeName (Function1Types::Sine< tensor >::typeName_())
int debug (::Foam::debug::debugSwitch(Function1Types::Sine< tensor >::typeName_(), 0))
Public Member Functions inherited from Function1< Type >
virtual const word & type () const
 Function1 (const word &entryName, const objectRegistry *obrPtr=nullptr)
 Construct from entry name.
 Function1 (const word &entryName, const dictionary &dict, const objectRegistry *obrPtr=nullptr)
 Construct from entry name, (unused) dictionary and optional registry.
 Function1 (const Function1< Type > &rhs)
 Copy construct.
virtual ~Function1 ()=default
 Destructor.
virtual bool constant () const
 Is value constant (i.e. independent of x).
virtual bool good () const
 Can function be evaluated?
virtual tmp< Field< Type > > value (const scalarField &x) const
 Return value as a function of (scalar) independent variable.
virtual tmp< Field< Type > > integrate (const scalarField &x1, const scalarField &x2) const
 Integrate between two (scalar) values.
const::Foam::word typeName (Function1< label >::typeName_())
int debug (::Foam::debug::debugSwitch(Function1< label >::typeName_(), 0))
Function1< label >::dictionaryConstructorTableType * dictionaryConstructorTablePtr_ (nullptr)
std::unique_ptr< Function1< label >::dictionaryConstructorCompatTableType > dictionaryConstructorCompatTablePtr_ (nullptr)
Function1< label >::dictionaryConstructorCompatTableType & dictionaryConstructorCompatTable ()
void dictionaryConstructorTablePtr_construct (bool load)
Function1< label >::dictionaryConstructorPtr dictionaryConstructorTable (const::Foam::word &k)
const::Foam::word typeName (Function1< scalar >::typeName_())
int debug (::Foam::debug::debugSwitch(Function1< scalar >::typeName_(), 0))
Function1< scalar >::dictionaryConstructorTableType * dictionaryConstructorTablePtr_ (nullptr)
std::unique_ptr< Function1< scalar >::dictionaryConstructorCompatTableType > dictionaryConstructorCompatTablePtr_ (nullptr)
Function1< scalar >::dictionaryConstructorCompatTableType & dictionaryConstructorCompatTable ()
void dictionaryConstructorTablePtr_construct (bool load)
Function1< scalar >::dictionaryConstructorPtr dictionaryConstructorTable (const::Foam::word &k)
const::Foam::word typeName (Function1< vector >::typeName_())
int debug (::Foam::debug::debugSwitch(Function1< vector >::typeName_(), 0))
Function1< vector >::dictionaryConstructorTableType * dictionaryConstructorTablePtr_ (nullptr)
std::unique_ptr< Function1< vector >::dictionaryConstructorCompatTableType > dictionaryConstructorCompatTablePtr_ (nullptr)
Function1< vector >::dictionaryConstructorCompatTableType & dictionaryConstructorCompatTable ()
void dictionaryConstructorTablePtr_construct (bool load)
Function1< vector >::dictionaryConstructorPtr dictionaryConstructorTable (const::Foam::word &k)
const::Foam::word typeName (Function1< sphericalTensor >::typeName_())
int debug (::Foam::debug::debugSwitch(Function1< sphericalTensor >::typeName_(), 0))
Function1< sphericalTensor >::dictionaryConstructorTableType * dictionaryConstructorTablePtr_ (nullptr)
std::unique_ptr< Function1< sphericalTensor >::dictionaryConstructorCompatTableType > dictionaryConstructorCompatTablePtr_ (nullptr)
Function1< sphericalTensor >::dictionaryConstructorCompatTableType & dictionaryConstructorCompatTable ()
void dictionaryConstructorTablePtr_construct (bool load)
Function1< sphericalTensor >::dictionaryConstructorPtr dictionaryConstructorTable (const::Foam::word &k)
const::Foam::word typeName (Function1< symmTensor >::typeName_())
int debug (::Foam::debug::debugSwitch(Function1< symmTensor >::typeName_(), 0))
Function1< symmTensor >::dictionaryConstructorTableType * dictionaryConstructorTablePtr_ (nullptr)
std::unique_ptr< Function1< symmTensor >::dictionaryConstructorCompatTableType > dictionaryConstructorCompatTablePtr_ (nullptr)
Function1< symmTensor >::dictionaryConstructorCompatTableType & dictionaryConstructorCompatTable ()
void dictionaryConstructorTablePtr_construct (bool load)
Function1< symmTensor >::dictionaryConstructorPtr dictionaryConstructorTable (const::Foam::word &k)
const::Foam::word typeName (Function1< tensor >::typeName_())
int debug (::Foam::debug::debugSwitch(Function1< tensor >::typeName_(), 0))
Function1< tensor >::dictionaryConstructorTableType * dictionaryConstructorTablePtr_ (nullptr)
std::unique_ptr< Function1< tensor >::dictionaryConstructorCompatTableType > dictionaryConstructorCompatTablePtr_ (nullptr)
Function1< tensor >::dictionaryConstructorCompatTableType & dictionaryConstructorCompatTable ()
void dictionaryConstructorTablePtr_construct (bool load)
Function1< tensor >::dictionaryConstructorPtr dictionaryConstructorTable (const::Foam::word &k)
const::Foam::word typeName (Function1< scalarField >::typeName_())
int debug (::Foam::debug::debugSwitch(Function1< scalarField >::typeName_(), 0))
Function1< scalarField >::dictionaryConstructorTableType * dictionaryConstructorTablePtr_ (nullptr)
std::unique_ptr< Function1< scalarField >::dictionaryConstructorCompatTableType > dictionaryConstructorCompatTablePtr_ (nullptr)
Function1< scalarField >::dictionaryConstructorCompatTableType & dictionaryConstructorCompatTable ()
void dictionaryConstructorTablePtr_construct (bool load)
Function1< scalarField >::dictionaryConstructorPtr dictionaryConstructorTable (const::Foam::word &k)
Public Member Functions inherited from function1Base
 function1Base (const word &entryName, const objectRegistry *obrPtr=nullptr)
 Construct from entry name and optional registry.
 function1Base (const word &entryName, const dictionary &dict, const objectRegistry *obrPtr=nullptr)
 Construct from entry name, dictionary (unused) and optional registry.
 function1Base (const function1Base &rhs)
 Copy construct.
virtual ~function1Base ()
 Destructor.
const word & name () const noexcept
 The name of the entry.
const objectRegistry * whichDb () const noexcept
 Return the associated registry or nullptr.
void resetDb (const objectRegistry *obrPtr=nullptr) noexcept
 Reset the associated objectRegistry.
void resetDb (const objectRegistry &db) noexcept
 Reset the associated objectRegistry.
const objectRegistry & obr () const
 Return the object registry.
bool isTime () const noexcept
 Return true if this function was created with the time database.
const Time & time () const
 Return the time database.
template<class MeshType>
const MeshType & mesh (const word &regionName=word::null) const
 Return the mesh database if this Function1 was created using a mesh.
Public Member Functions inherited from refCount
constexpr refCount () noexcept
 Default construct, initializing count to 0.
int use_count () const noexcept
 Return the current reference count.
bool unique () const noexcept
 Return true if the reference count is zero.
void operator++ () noexcept
 Increment the reference count.
void operator++ (int) noexcept
 Increment the reference count.
void operator-- () noexcept
 Decrement the reference count.
void operator-- (int) noexcept
 Decrement the reference count.

Protected Member Functions

scalar cycle (const scalar t) const
 The cycle: (freq * time) or (time / period).
scalar cosForm (const scalar t) const
 Calculated cos value at time t.
scalar sinForm (const scalar t) const
 Calculated sin value at time t.
scalar squareForm (const scalar t, const scalar posFrac) const
 Calculated square value at time t.
Type cosValue (const scalar t) const
 Return value for time t, using cos form.
Type sinValue (const scalar t) const
 Return value for time t, using sin form.
Type squareValue (const scalar t, const scalar posFrac) const
 Return value for time t, using square form.
Protected Member Functions inherited from Function1< Type >
void operator= (const Function1< Type > &)=delete
 No copy assignment.
Protected Member Functions inherited from function1Base
void operator= (const function1Base &)=delete
 No copy assignment.

Protected Attributes

scalar t0_
 Start-time for the function.
autoPtr< Function1< scalar > > amplitude_
 Scalar amplitude of the function (optional).
autoPtr< Function1< scalar > > period_
 Period of the function (or specify frequency).
autoPtr< Function1< scalar > > frequency_
 Frequency of the function (or specify period).
autoPtr< Function1< Type > > scale_
 Scaling factor for the function.
autoPtr< Function1< Type > > level_
 Level to add to the scaled function.
Protected Attributes inherited from function1Base
const word name_
 Name of entry.
const objectRegistry * obrPtr_
 Pointer to an object registry.

Additional Inherited Members

Public Types inherited from Function1< Type >
typedef Type returnType
 The return type.
typedef autoPtr< Function1 >(* dictionaryConstructorPtr) (const word &entryName, const dictionary &dict, const objectRegistry *obrPtr)
 Declare runtime constructor selection table.
typedef ::Foam::HashTable< dictionaryConstructorPtr, ::Foam::word, ::Foam::Hash<::Foam::word > > dictionaryConstructorTableType
typedef ::Foam::HashTable< std::pair<::Foam::word, int >, ::Foam::word, ::Foam::Hash<::Foam::word > > dictionaryConstructorCompatTableType
Static Public Member Functions inherited from Function1< Type >
static const char * typeName_ ()
 Runtime type information.
static dictionaryConstructorCompatTableType & dictionaryConstructorCompatTable ()
static void dictionaryConstructorTablePtr_construct (bool load)
static dictionaryConstructorPtr dictionaryConstructorTable (const ::Foam::word &k)
template<class Derived>
static tmp< Function1< Type > > Clone (const Derived &fun)
 Clone a Function1.
static autoPtr< Function1< Type > > New (const word &entryName, const dictionary &dict, const word &redirectType, const objectRegistry *obrPtr=nullptr, const bool mandatory=true)
 Selector, with fallback redirection.
static autoPtr< Function1< Type > > NewCompat (const word &entryName, std::initializer_list< std::pair< const char *, int > > compat, const dictionary &dict, const word &redirectType=word::null, const objectRegistry *obrPtr=nullptr, const bool mandatory=true)
 Compatibility selector, with fallback redirection.
static autoPtr< Function1< Type > > New (const word &entryName, const dictionary &dict, const objectRegistry *obrPtr=nullptr, const bool mandatory=true)
 Selector, without fallback redirection.
static autoPtr< Function1< Type > > NewIfPresent (const word &entryName, const dictionary &dict, const word &redirectType, const objectRegistry *obrPtr=nullptr)
 An optional selector, with fallback redirection.
static autoPtr< Function1< Type > > NewIfPresent (const word &entryName, const dictionary &dict, const objectRegistry *obrPtr=nullptr)
 An optional selector, without fallback redirection.
static refPtr< Function1< Type > > New (HashPtrTable< Function1< Type > > &cache, const word &entryName, const dictionary &dict, enum keyType::option matchOpt=keyType::LITERAL, const objectRegistry *obrPtr=nullptr, const bool mandatory=true)
 Selector with external storage of Function1. This also allows wildcard matches in a dictionary.
Static Public Attributes inherited from Function1< Type >
static const ::Foam::word typeName
static int debug
static dictionaryConstructorTableType * dictionaryConstructorTablePtr_
static std::unique_ptr< dictionaryConstructorCompatTableType > dictionaryConstructorCompatTablePtr_

Detailed Description

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

A templated sine function, with support for offset etc.

The wave period can be specified directly

\‍[ a sin(2 \pi (t - t0) / p)) s + l \‍]

Or it can be specified by the frequency

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

where

$ Symbol $=Description Units
$ a $=Amplitude -
$ f $=Frequency [1/s]
$ p $=Period [s]
$ s $=Type scale factor -
$ l $=Type offset level -
$ t $=Time [s]
$ t0 $=Start time offset [s]

The dictionary specification would typically resemble this: 

    entry1
    {
        type        sine;
        frequency   10;
        amplitude   0.1;

        // A scalar Function1
        scale       2e-6;
        level       2e-6;
    }
    entry2
    {
        type        sine;
        frequency   10;

        // A vector Function1
        scale       (1 0.1 0);
        level       (10 1 0);
    }

where the entries mean:

Property Description Type Reqd Default
type Function type: sine word yes
amplitude Amplitude Function1<scalar> no 1
frequency Frequency [1/s] Function1<scalar> or period
period Period [s] Function1<scalar> or frequency
scale Scale factor (Type) Function1<Type> yes
level Offset level (Type) Function1<Type> yes
t0 Start time offset scalar no 0
Note
For slow oscillations it can be more intuitive to specify the period.
Source files

Definition at line 201 of file Sine.H.

Constructor & Destructor Documentation

◆ Sine() [1/2]

template<class Type>
Sine ( const word & entryName,
const dictionary & dict,
const objectRegistry * obrPtr = nullptr )

Construct from entry name, dictionary and optional registry.

Definition at line 27 of file Sine.C.

References amplitude_, dict, frequency_, Function1< Type >::Function1(), level_, Function1< Type >::NewIfPresent(), period_, scale_, and t0_.

Referenced by Cosine< Type >::Cosine(), Cosine< Type >::Cosine(), operator=(), Sine(), Square< Type >::Square(), and Square< Type >::Square().

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

◆ Sine() [2/2]

template<class Type>
Sine ( const Sine< Type > & rhs)
explicit

Copy construct.

Definition at line 56 of file Sine.C.

References amplitude_, clone(), frequency_, Function1< Type >::Function1(), level_, period_, Foam::rhs(), scale_, Sine(), and t0_.

Here is the call graph for this function:

◆ ~Sine()

template<class Type>
virtual ~Sine ( )
virtualdefault

Destructor.

Member Function Documentation

◆ cycle()

template<class Type>
Foam::scalar cycle ( const scalar t) const
inlineprotected

The cycle: (freq * time) or (time / period).

Definition at line 27 of file SineI.H.

References frequency_, period_, and t0_.

Referenced by cosForm(), sinForm(), and squareForm().

Here is the caller graph for this function:

◆ cosForm()

template<class Type>
Foam::scalar cosForm ( const scalar t) const
inlineprotected

Calculated cos value at time t.

Definition at line 44 of file SineI.H.

References amplitude_, Foam::cos(), cycle(), and Foam::constant::mathematical::twoPi().

Referenced by cosValue().

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

◆ sinForm()

template<class Type>
Foam::scalar sinForm ( const scalar t) const
inlineprotected

Calculated sin value at time t.

Definition at line 56 of file SineI.H.

References amplitude_, cycle(), Foam::sin(), and Foam::constant::mathematical::twoPi().

Referenced by sinValue().

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

◆ squareForm()

template<class Type>
Foam::scalar squareForm ( const scalar t,
const scalar posFrac ) const
inlineprotected

Calculated square value at time t.

The positive fraction is 0-1

Definition at line 68 of file SineI.H.

References amplitude_, and cycle().

Referenced by squareValue().

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

◆ cosValue()

template<class Type>
Type cosValue ( const scalar t) const
inlineprotected

Return value for time t, using cos form.

Definition at line 86 of file SineI.H.

References cosForm(), level_, and scale_.

Referenced by integrate(), and Cosine< Type >::value().

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

◆ sinValue()

template<class Type>
Type sinValue ( const scalar t) const
inlineprotected

Return value for time t, using sin form.

Definition at line 96 of file SineI.H.

References level_, scale_, and sinForm().

Referenced by Cosine< Type >::integrate(), and value().

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

◆ squareValue()

template<class Type>
Type squareValue ( const scalar t,
const scalar posFrac ) const
inlineprotected

Return value for time t, using square form.

Definition at line 106 of file SineI.H.

References level_, scale_, and squareForm().

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

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

◆ TypeName()

template<class Type>
TypeName ( "sine" )

◆ operator=()

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

No copy assignment.

References dict, Foam::rhs(), and Sine().

Here is the call graph for this function:

◆ clone()

template<class Type>
virtual tmp< Function1< Type > > clone ( ) const
inlinevirtual

Return a clone.

Implements Function1< Type >.

Reimplemented in Cosine< Type >, and Square< Type >.

Definition at line 314 of file Sine.H.

References Function1< Type >::Clone().

Referenced by Sine().

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

◆ userTimeToTime()

template<class Type>
void userTimeToTime ( const Time & t)
virtual

Convert time.

Reimplemented from function1Base.

Definition at line 71 of file Sine.C.

References t0_, and TimeState::userTimeToTime().

Here is the call graph for this function:

◆ value()

template<class Type>
virtual Type value ( const scalar t) const
inlinevirtual

Return value for time t.

Reimplemented from Function1< Type >.

Reimplemented in Cosine< Type >, and Square< Type >.

Definition at line 336 of file Sine.H.

References sinValue().

Here is the call graph for this function:

◆ integrate()

template<class Type>
virtual Type integrate ( const scalar x1,
const scalar x2 ) const
inlinevirtual

Integrate between two (scalar) values.

Reimplemented from Function1< Type >.

Reimplemented in Cosine< Type >.

Definition at line 344 of file Sine.H.

References cosValue().

Here is the call graph for this function:

◆ writeData()

template<class Type>
void writeData ( Ostream & os) const
virtual

Write in dictionary format.

Reimplemented from Function1< Type >.

Reimplemented in Square< Type >.

Definition at line 99 of file Sine.C.

References name, os(), Function1< Type >::writeData(), and writeEntries().

Here is the call graph for this function:

◆ writeEntries()

template<class Type>
void writeEntries ( Ostream & os) const
virtual

Write coefficient entries in dictionary format.

Reimplemented from Function1< Type >.

Reimplemented in Square< Type >.

Definition at line 78 of file Sine.C.

References amplitude_, frequency_, level_, os(), period_, scale_, and t0_.

Referenced by writeData(), and Square< Type >::writeEntries().

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

◆ typeName() [1/5]

const::Foam::word typeName ( Function1Types::Sine< scalar > ::typeName_())

◆ debug() [1/5]

int debug ( ::Foam::debug::debugSwitch(Function1Types::Sine< scalar >::typeName_(), 0) )

◆ typeName() [2/5]

const::Foam::word typeName ( Function1Types::Sine< vector > ::typeName_())

◆ debug() [2/5]

int debug ( ::Foam::debug::debugSwitch(Function1Types::Sine< vector >::typeName_(), 0) )

◆ typeName() [3/5]

const::Foam::word typeName ( Function1Types::Sine< sphericalTensor > ::typeName_())

◆ debug() [3/5]

int debug ( ::Foam::debug::debugSwitch(Function1Types::Sine< sphericalTensor >::typeName_(), 0) )

◆ typeName() [4/5]

const::Foam::word typeName ( Function1Types::Sine< symmTensor > ::typeName_())

◆ debug() [4/5]

int debug ( ::Foam::debug::debugSwitch(Function1Types::Sine< symmTensor >::typeName_(), 0) )

◆ typeName() [5/5]

const::Foam::word typeName ( Function1Types::Sine< tensor > ::typeName_())

◆ debug() [5/5]

int debug ( ::Foam::debug::debugSwitch(Function1Types::Sine< tensor >::typeName_(), 0) )

Member Data Documentation

◆ t0_

template<class Type>
scalar t0_
protected

Start-time for the function.

Definition at line 212 of file Sine.H.

Referenced by cycle(), Sine(), Sine(), userTimeToTime(), and writeEntries().

◆ amplitude_

template<class Type>
autoPtr<Function1<scalar> > amplitude_
protected

Scalar amplitude of the function (optional).

Definition at line 217 of file Sine.H.

Referenced by cosForm(), Sine(), Sine(), sinForm(), squareForm(), and writeEntries().

◆ period_

template<class Type>
autoPtr<Function1<scalar> > period_
protected

Period of the function (or specify frequency).

Definition at line 222 of file Sine.H.

Referenced by cycle(), Sine(), Sine(), and writeEntries().

◆ frequency_

template<class Type>
autoPtr<Function1<scalar> > frequency_
protected

Frequency of the function (or specify period).

Definition at line 227 of file Sine.H.

Referenced by cycle(), Sine(), Sine(), and writeEntries().

◆ scale_

template<class Type>
autoPtr<Function1<Type> > scale_
protected

Scaling factor for the function.

Definition at line 232 of file Sine.H.

Referenced by cosValue(), Sine(), Sine(), sinValue(), squareValue(), and writeEntries().

◆ level_

template<class Type>
autoPtr<Function1<Type> > level_
protected

Level to add to the scaled function.

Definition at line 237 of file Sine.H.

Referenced by cosValue(), Sine(), Sine(), sinValue(), squareValue(), and writeEntries().

The documentation for this class was generated from the following files:
  • src/OpenFOAM/primitives/functions/Function1/Sine/Sine.H
  • src/OpenFOAM/primitives/functions/Function1/Sine/Sine.C
  • src/OpenFOAM/primitives/functions/Function1/Sine/SineI.H