Templated square-wave function with support for an offset level. More...

Inheritance diagram for Square< Type >:

Collaboration diagram for Square< Type >:

Public Member Functions
	TypeName ("square")

	Square (const word &entryName, const dictionary &dict)
	Construct from entry name and dictionary. More...

	Square (const Square< Type > &se)
	Copy constructor. More...

virtual	~Square ()
	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 Square< Type > &)=delete
	Disallow default bitwise assignment. More...

Public Member Functions inherited from FieldFunction1< Type, Square< Type > >
	FieldFunction1 (const word &entryName)
	Construct from entry name. More...

	FieldFunction1 (const FieldFunction1< Type, Square< 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::Square< Type >

Templated square-wave function with support for an offset level.

$a square(f (x - x_0) ) + l$

where

$square(x)$ is the square-wave function in range $[-1, 1]$ with a mark/space ratio of $r$

=	Description	Data type	Default
=	Amplitude	Function1<Type>
=	Frequency	scalar
=	Phase	scalar	0
=	Offset level	Function1<Type>
=	Mark/space ratio	scalar	1

Example for a scalar:

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

Example for a vector:

        <entryName> square;
        <entryName>Coeffs
        {
            amplitude (1 0.1 0);
            frequency 10;
            start     0;
            level     (10 1 0);
            markSpace 0.5;
        }

Source files

Definition at line 131 of file Square.H.