A scalar-valued sinusoidal function. More...

#include <Functions.h>

Inheritance diagram for SineFunc:

Collaboration diagram for SineFunc:

Public Member Functions
	SineFunc (Real s=Real(1), Real f=Real(1), Real p=Real(0))
	Constructor initializing the function parameters.

bool	isZero () const override
	Returns whether the function is identically zero or not.

bool	isConstant () const override
	Returns whether the function is time-independent or not.

Real	deriv (Real x) const override
	Returns the first-derivative of the function.

Public Member Functions inherited from ScalarFunc
Real	eval (Real x) const
	Returns the function value for the argument x.

Public Member Functions inherited from utl::Function< Real, Real >
virtual	~Function ()
	Empty destructor.

Real	operator() (const Real &x) const
	Operator returning the function value for the given argument.

Protected Member Functions
Real	evaluate (const Real &x) const override
	Evaluates the function at x.

Protected Member Functions inherited from ScalarFunc
	ScalarFunc ()
	The constructor is protected to allow sub-class instances only.

Protected Member Functions inherited from utl::Function< Real, Real >
	Function ()
	The constructor is protected to allow sub-class instances only.

Private Attributes
Real	scale
	Amplitude of the sine function.

Real	freq
	Angular frequency of the sine function.

Real	phase
	Phase shift of the sine function.

Additional Inherited Members
Public Types inherited from utl::Function< Real, Real >
typedef Real	Input
	Input type.

typedef Real	Output
	Output type.

Detailed Description

A scalar-valued sinusoidal function.

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

Public Member Functions