Cosine< Type > Class Template Reference

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

Inheritance diagram for Cosine< Type >:

Collaboration diagram for Cosine< Type >:

Public Member Functions
	TypeName ("cosine")
void	operator= (const Cosine< Type > &)=delete
	No copy assignment. More...
	Cosine (const word &entryName, const dictionary &dict, const objectRegistry *obrPtr=nullptr)
	Construct from entry name, dictionary and optional registry. More...
	Cosine (const Cosine< Type > &rhs)
	Copy construct. More...
virtual tmp< Function1< Type > >	clone () const
	Construct and return a clone. More...
virtual	~Cosine ()=default
	Destructor. More...
virtual Type	value (const scalar t) const
	Return value for time t. More...
Public Member Functions inherited from Sine< Type >
	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
	Construct and 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 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)
	Function1 (const Function1< Type > &rhs)
	Copy construct. More...
virtual tmp< Function1< Type > >	clone () const =0
	Construct and return a clone. 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 Type	value (const scalar x) const
	Return value as a function of (scalar) independent variable. More...
virtual tmp< Field< Type > >	value (const scalarField &x) const
	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
	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 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...
virtual void	userTimeToTime (const Time &t)
	Convert time. More...
Public Member Functions inherited from refCount
constexpr	refCount () noexcept
	Default construct, initializing count to 0. More...
int	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...

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, 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=word::null, const objectRegistry *obrPtr=nullptr)
	An optional selector. 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)
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
Protected Member Functions inherited from Sine< Type >
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 inherited from Sine< Type >
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...

Detailed Description

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

A templated cosine function, with support for offset etc.

The wave period can be specified directly

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

Or it can be specified by the frequency

\[ a cos(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        cosine;
        frequency   10;
        amplitude   0.1;

        // A scalar Function1
        scale       2e-6;
        level       2e-6;
    }
    entry2
    {
        type        cosine;
        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: cosine	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

• Cosine.H
• Cosine.C

Definition at line 203 of file Cosine.H.

Constructor & Destructor Documentation

Cosine() [1/2]

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

inline

Construct from entry name, dictionary and optional registry.

Definition at line 222 of file Cosine.H.

Cosine() [2/2]

Cosine ( const Cosine< Type > &  rhs )

inlineexplicit

Copy construct.

Definition at line 233 of file Cosine.H.

~Cosine()

virtual ~Cosine ( )

virtualdefault

Destructor.

Member Function Documentation

TypeName()

TypeName

(

"cosine"

)

operator=()

void operator= ( const Cosine< Type > &  )

delete

No copy assignment.

clone()

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

inlinevirtual

Construct and return a clone.

Reimplemented from Sine< Type >.

Definition at line 239 of file Cosine.H.

value()

virtual Type value ( const scalar  t ) const

inlinevirtual

Return value for time t.

Reimplemented from Sine< Type >.

Definition at line 252 of file Cosine.H.

References Sine< Type >::cosValue().

Here is the call graph for this function:

---

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

• src/OpenFOAM/primitives/functions/Function1/Cosine/Cosine.H