Public Member Functions | List of all members
Square< Type > Class Template Reference

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

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

Public Member Functions

 TypeName ("square")
 
 Square (const word &name, const unitConversions &units, const dictionary &dict)
 Construct from 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 integral (const scalar x1, const scalar x2) const
 Integrate between two values. More...
 
virtual void write (Ostream &os, const unitConversions &units) const
 Write data to dictionary stream. More...
 
void operator= (const Square< Type > &)=delete
 Disallow default bitwise assignment. More...
 
- Public Member Functions inherited from FieldFunction1< Type, Square< Type > >
 FieldFunction1 (const word &name)
 Construct from name. 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 one scalar field. More...
 
virtual tmp< Field< Type > > integral (const scalarField &x1, const scalarField &x2) const
 Integrate between two scalar fields. More...
 
- Public Member Functions inherited from Function1< Type >
 TypeName ("Function1")
 Runtime type information. More...
 
 declareRunTimeSelectionTable (autoPtr, Function1, dictionary,(const word &name, const Function1s::unitConversions &units, const dictionary &dict),(name, units, dict))
 
 declareRunTimeSelectionTable (autoPtr, Function1, Istream,(const word &name, const Function1s::unitConversions &units, Istream &is),(name, units, is))
 
 Function1 (const word &name)
 Construct from 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...
 
virtual bool constant () const
 Is this function guaranteed to be constant? More...
 
void operator= (const Function1< Type > &)
 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...
 
void operator= (const refCount &)=delete
 Disallow bitwise assignment. 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 &name, const Function1s::unitConversions &units, const dictionary &dict)
 Select from dictionary. More...
 
static autoPtr< Function1< Type > > New (const word &name, const unitConversion &xUnits, const unitConversion &valueUnits, const dictionary &dict)
 Select from dictionary. More...
 
static autoPtr< Function1< Type > > New (const word &name, const Function1s::unitConversions &units, const word &Function1Type, Istream &is)
 Select from Istream. More...
 
static autoPtr< Function1< Type > > New (const word &name, const unitConversion &xUnits, const unitConversion &valueUnits, const word &Function1Type, Istream &is)
 Select from Istream. More...
 
- Protected Member Functions inherited from refCount
 refCount ()
 Construct null initialising count to 0. More...
 
 refCount (const refCount &)=delete
 Disallow copy. 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$

$ Symbol $ = Description Data type Default
$ a $ = Amplitude Function1<Type>
$ f $ = Frequency scalar
$ x_0 $ = Phase scalar 0
$ l $ = Offset level Function1<Type>
$ r $ = Mark/space ratio scalar 1

Example for a scalar: 

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

Example for a vector: 

        <name> square;
        <name>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.

Constructor & Destructor Documentation

◆ Square() [1/2]

Square ( const word &  name,
const unitConversions &  units,
const dictionary &  dict 
)

Construct from name and dictionary.

Definition at line 31 of file Square.C.

◆ Square() [2/2]

Square ( const Square< Type > &  se)

Copy constructor.

Definition at line 49 of file Square.C.

◆ ~Square()

~Square
virtual

Destructor.

Definition at line 64 of file Square.C.

Member Function Documentation

◆ TypeName()

TypeName ( "square"  )

◆ value()

Type value ( const scalar  x) const
inlinevirtual

Return value.

Implements FieldFunction1< Type, Square< Type > >.

Definition at line 32 of file SquareI.H.

References x.

◆ integral()

Type integral ( const scalar  x1,
const scalar  x2 
) const
inlinevirtual

Integrate between two values.

Implements FieldFunction1< Type, Square< Type > >.

Definition at line 46 of file SquareI.H.

References Foam::exit(), Foam::FatalError, FatalErrorInFunction, Foam::type(), and x.

Here is the call graph for this function:

◆ write()

void write ( Ostream &  os,
const unitConversions &  units 
) const
virtual

Write data to dictionary stream.

Implements Function1< Type >.

Definition at line 71 of file Square.C.

References Foam::unitless, Foam::units(), and Foam::Function1s::writeEntry().

Here is the call graph for this function:

◆ operator=()

void operator= ( const Square< Type > &  )
delete

Disallow default bitwise assignment.

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