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

Inheritance diagram for Sine< Type >:

Collaboration diagram for Sine< Type >:

Public Member Functions
	TypeName ("sine")

void	operator= (const Sine< Type > &)=delete
	No copy assignment. More...

	Sine (const word &entryName, const dictionary &dict, const objectRegistry *obrPtr=nullptr)
	Construct from entry name, dictionary and optional registry. More...

	Sine (const Sine< Type > &rhs)
	Copy construct. More...

virtual tmp< Function1< Type > >	clone () const
	Return a clone. More...

virtual	~Sine ()=default
	Destructor. More...

virtual void	userTimeToTime (const Time &t)
	Convert time. More...

virtual Type	value (const scalar t) const
	Return value for time t. More...

virtual Type	integrate (const scalar x1, const scalar x2) const
	Integrate between two (scalar) values. More...

virtual void	writeData (Ostream &os) const
	Write in dictionary format. More...

virtual void	writeEntries (Ostream &os) const
	Write coefficient entries in dictionary format. More...

Public Member Functions inherited from Function1< Type >
	TypeName ("Function1") declareRunTimeSelectionTable(autoPtr
	Runtime type information. More...

	Function1 (const word &entryName, const objectRegistry *obrPtr=nullptr)
	Construct from entry name. More...

	Function1 (const word &entryName, const dictionary &dict, const objectRegistry *obrPtr=nullptr)
	Construct from entry name, (unused) dictionary and optional registry. More...

	Function1 (const Function1< Type > &rhs)
	Copy construct. More...

virtual	~Function1 ()=default
	Destructor. More...

virtual bool	constant () const
	Is value constant (i.e. independent of x) More...

virtual bool	good () const
	Can function be evaluated? 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 function1Base
	function1Base (const word &entryName, const objectRegistry *obrPtr=nullptr)
	Construct from entry name and optional registry. More...

	function1Base (const word &entryName, const dictionary &dict, const objectRegistry *obrPtr=nullptr)
	Construct from entry name, dictionary (unused) and optional registry. More...

	function1Base (const function1Base &rhs)
	Copy construct. More...

virtual	~function1Base ()
	Destructor. More...

const word &	name () const noexcept
	The name of the entry. More...

const objectRegistry *	whichDb () const noexcept
	Return the associated registry or nullptr. More...

void	resetDb (const objectRegistry *obrPtr=nullptr) noexcept
	Reset the associated objectRegistry. More...

void	resetDb (const objectRegistry &db) noexcept
	Reset the associated objectRegistry. More...

const objectRegistry &	obr () const
	Return the object registry. More...

bool	isTime () const noexcept
	Return true if this function was created with the time database. More...

const Time &	time () const
	Return the time database. More...

template<class MeshType >
const MeshType &	mesh (const word &regionName=word::null) const
	Return the mesh database if this Function1 was created using a mesh. More...

Public Member Functions inherited from refCount
constexpr	refCount () noexcept
	Default construct, initializing count to 0. More...

int	use_count () const noexcept
	Return the current reference count. More...

bool	unique () const noexcept
	Return true if the reference count is zero. More...

void	operator++ () noexcept
	Increment the reference count. More...

void	operator++ (int) noexcept
	Increment the reference count. More...

void	operator-- () noexcept
	Decrement the reference count. More...

void	operator-- (int) noexcept
	Decrement the reference count. More...

Protected Member Functions
scalar	cycle (const scalar t) const
	The cycle: (freq * time) or (time / period) More...

scalar	cosForm (const scalar t) const
	Calculated cos value at time t. More...

scalar	sinForm (const scalar t) const
	Calculated sin value at time t. More...

scalar	squareForm (const scalar t, const scalar posFrac) const
	Calculated square value at time t. More...

Type	cosValue (const scalar t) const
	Return value for time t, using cos form. More...

Type	sinValue (const scalar t) const
	Return value for time t, using sin form. More...

Type	squareValue (const scalar t, const scalar posFrac) const
	Return value for time t, using square form. More...

Protected Member Functions inherited from Function1< Type >
void	operator= (const Function1< Type > &)=delete
	No copy assignment. More...

Protected Member Functions inherited from function1Base
void	operator= (const function1Base &)=delete
	No copy assignment. More...

Protected Attributes
scalar	t0_
	Start-time for the function. More...

autoPtr< Function1< scalar > >	amplitude_
	Scalar amplitude of the function (optional) More...

autoPtr< Function1< scalar > >	period_
	Period of the function (or specify frequency) More...

autoPtr< Function1< scalar > >	frequency_
	Frequency of the function (or specify period) More...

autoPtr< Function1< Type > >	scale_
	Scaling factor for the function. More...

autoPtr< Function1< Type > >	level_
	Level to add to the scaled function. More...

Protected Attributes inherited from function1Base
const word	name_
	Name of entry. More...

const objectRegistry *	obrPtr_
	Pointer to an object registry. More...

Additional Inherited Members
Public Types inherited from Function1< Type >
typedef Type	returnType
	The return type. More...

Static Public Member Functions inherited from Function1< Type >
template<class Derived >
static tmp< Function1< Type > >	Clone (const Derived &fun)
	Clone a Function1. More...

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. More...

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. More...

static autoPtr< Function1< Type > >	New (const word &entryName, const dictionary &dict, const objectRegistry *obrPtr=nullptr, const bool mandatory=true)
	Selector, without fallback redirection. More...

static autoPtr< Function1< Type > >	NewIfPresent (const word &entryName, const dictionary &dict, const word &redirectType, const objectRegistry *obrPtr=nullptr)
	An optional selector, with fallback redirection. More...

static autoPtr< Function1< Type > >	NewIfPresent (const word &entryName, const dictionary &dict, const objectRegistry *obrPtr=nullptr)
	An optional selector, without fallback redirection. More...

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. More...

Public Attributes inherited from Function1< Type >
	Function1

	dictionary

const word &	entryName

const word const dictionary &	dict

const word const dictionary const objectRegistry *	obrPtr

const word const dictionary const objectRegistry	entryName

const word const dictionary const objectRegistry	dict

const word const dictionary const objectRegistry	obrPtr

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

=	Description	Units
=	Amplitude	-
=	Frequency	[1/s]
=	Period	[s]
=	Type scale factor	-
=	Type offset level	-
=	Time	[s]
=	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]

Sine	(	const word &	entryName,
		const dictionary &	dict,
		const objectRegistry *	obrPtr = `nullptr`
	)

Construct from entry name, dictionary and optional registry.

Definition at line 28 of file Sine.C.

References dict, and Foam::New().

Here is the call graph for this function:

◆ Sine() [2/2]

Sine ( const Sine< Type > & rhs )

explicit

Copy construct.

Definition at line 56 of file Sine.C.

◆ ~Sine()

virtual ~Sine ( )

virtualdefault

Destructor.

Member Function Documentation

◆ cycle()

Foam::scalar cycle ( const scalar t ) const

inlineprotected

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

Definition at line 28 of file SineI.H.

◆ cosForm()

Foam::scalar cosForm ( const scalar t ) const

inlineprotected

Calculated cos value at time t.

Definition at line 44 of file SineI.H.

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

Here is the call graph for this function:

◆ sinForm()

Foam::scalar sinForm ( const scalar t ) const

inlineprotected

Calculated sin value at time t.

Definition at line 56 of file SineI.H.

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

Here is the call graph for this function:

◆ squareForm()

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 69 of file SineI.H.

◆ cosValue()

Type cosValue ( const scalar t ) const

inlineprotected

Return value for time t, using cos form.

Definition at line 86 of file SineI.H.

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

Here is the caller graph for this function:

◆ sinValue()

Type sinValue ( const scalar t ) const

inlineprotected

Return value for time t, using sin form.

Definition at line 96 of file SineI.H.

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

Here is the caller graph for this function:

◆ squareValue()

Type squareValue	(	const scalar	t,
		const scalar	posFrac
	)		const

inlineprotected

Return value for time t, using square form.

Definition at line 107 of file SineI.H.

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

Here is the caller graph for this function:

◆ TypeName()

TypeName ( "sine" )

◆ operator=()

void operator= ( const Sine< Type > & )

delete

No copy assignment.

◆ clone()

virtual tmp<Function1<Type> > clone ( ) const

inlinevirtual

Return a clone.

Implements Function1< Type >.

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

Definition at line 314 of file Sine.H.

References Function1< Type >::Clone().

Here is the call graph for this function:

◆ userTimeToTime()

void userTimeToTime ( const Time & t )

virtual

Convert time.

Reimplemented from function1Base.

Definition at line 71 of file Sine.C.

References TimeState::userTimeToTime().

Here is the call graph for this function:

◆ value()

virtual Type value ( const scalar t ) const

inlinevirtual

Return value for time t.

Reimplemented from Function1< Type >.

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

Definition at line 336 of file Sine.H.

References Sine< Type >::sinValue().

Here is the call graph for this function:

◆ integrate()

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 Sine< Type >::cosValue().

Here is the call graph for this function:

◆ writeData()

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 Ostream::beginBlock(), Ostream::endBlock(), Ostream::endEntry(), Foam::name(), and Function1< Type >::writeData().

Here is the call graph for this function:

◆ writeEntries()

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 Ostream::writeEntryIfDifferent().

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

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

◆ t0_

scalar t0_

protected

Start-time for the function.

Definition at line 212 of file Sine.H.

◆ amplitude_

autoPtr<Function1<scalar> > amplitude_

protected

Scalar amplitude of the function (optional)

Definition at line 217 of file Sine.H.

◆ period_

autoPtr<Function1<scalar> > period_

protected

Period of the function (or specify frequency)

Definition at line 222 of file Sine.H.

◆ frequency_

autoPtr<Function1<scalar> > frequency_

protected

Frequency of the function (or specify period)

Definition at line 227 of file Sine.H.

◆ scale_

autoPtr<Function1<Type> > scale_

protected

Scaling factor for the function.

Definition at line 232 of file Sine.H.

◆ level_

autoPtr<Function1<Type> > level_

protected

Level to add to the scaled function.

Definition at line 237 of file Sine.H.

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

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

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

Constructor & Destructor Documentation

◆ Sine() [1/2]

◆ Sine() [2/2]

◆ ~Sine()

Member Function Documentation

◆ cycle()

◆ cosForm()

◆ sinForm()

◆ squareForm()

◆ cosValue()

◆ sinValue()

◆ squareValue()

◆ TypeName()

◆ operator=()

◆ clone()

◆ userTimeToTime()

◆ value()

◆ integrate()

◆ writeData()

◆ writeEntries()

Member Data Documentation

◆ t0_

◆ amplitude_

◆ period_

◆ frequency_

◆ scale_

◆ level_

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