Square pulse function. Takes a value of 0 before start, then rises instantaneously to 1, remains at 1 for duration, then drops instantaneously back to 0. More...

Inheritance diagram for squarePulse:

[legend]

Collaboration diagram for squarePulse:

[legend]

Public Member Functions
	TypeName ("squarePulse")

	squarePulse (const word &name, const dictionary &dict)
	Construct from name and dictionary. More...

virtual	~squarePulse ()
	Destructor. More...

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

virtual scalar	integral (const scalar t1, const scalar t2) const
	Return the integral between times t1 and t2. More...

virtual void	write (Ostream &os) const
	Write data to dictionary stream. More...

void	operator= (const squarePulse &)=delete
	Disallow default bitwise assignment. More...

Public Member Functions inherited from FieldFunction1< scalar, squarePulse >
	FieldFunction1 (const word &name)
	Construct from name. More...

virtual tmp< Function1< scalar > >	clone () const
	Construct and return a clone. More...

virtual	~FieldFunction1 ()
	Destructor. More...

virtual tmp< Field< scalar > >	value (const scalarField &x) const
	Return value as a function of one scalar field. More...

virtual tmp< Field< scalar > >	integral (const scalarField &x1, const scalarField &x2) const
	Integrate between two scalar fields. More...

Public Member Functions inherited from Function1< scalar >
	Function1 (const word &name)
	Construct from name. More...

	Function1 (const Function1< scalar > &f1)
	Copy constructor. More...

const word &	name () const
	Return the name of the entry. More...

	TypeName ("Function1") declareRunTimeSelectionTable(autoPtr
	Runtime type information. More...

virtual	~Function1 ()
	Destructor. More...

void	operator= (const Function1< scalar > &)
	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< scalar >
typedef scalar	returnType

Static Public Member Functions inherited from Function1< scalar >
static autoPtr< Function1< scalar > >	New (const word &name, const dictionary &dict)
	Selector. More...

Public Attributes inherited from Function1< scalar >
	Function1

	dictionary

const word &	name

const word const dictionary	name

const word const dictionary &	dict

const word const dictionary	dict

Protected Member Functions inherited from refCount
	refCount ()
	Construct null initialising count to 0. More...

Protected Attributes inherited from Function1< scalar >
const word	name_
	Name of entry. More...

Detailed Description

Square pulse function. Takes a value of 0 before start, then rises instantaneously to 1, remains at 1 for duration, then drops instantaneously back to 0.

Usage:

    <name> squarePulse;
    <name>Coeffs
    {
        start     10;
        duration  20;
    }

or

    <name>
    {
        type      squarePulse;
        start     10;
        duration  20;
    }

Where:

Property	Description	Required	Default value
`start`	Start time	no	0
`duration`	Duration	yes

See also: Foam::Function1

Source files

Definition at line 96 of file squarePulse.H.

Constructor & Destructor Documentation

◆ squarePulse()

squarePulse	(	const word &	name,
		const dictionary &	dict
	)

Construct from name and dictionary.

Definition at line 49 of file squarePulse.C.

References Foam::read().

Here is the call graph for this function:

◆ ~squarePulse()

~squarePulse ( )

virtual

Destructor.

Definition at line 62 of file squarePulse.C.

Member Function Documentation

◆ TypeName()

TypeName ( "squarePulse" )

◆ value()

Foam::scalar value ( const scalar t ) const

inlinevirtual

Return value for time t.

Implements FieldFunction1< scalar, squarePulse >.

Definition at line 30 of file squarePulseI.H.

References squarePulse::integral().

Here is the call graph for this function:

◆ integral()

Foam::scalar integral	(	const scalar	t1,
		const scalar	t2
	)		const

inlinevirtual

Return the integral between times t1 and t2.

Implements FieldFunction1< scalar, squarePulse >.

Definition at line 37 of file squarePulseI.H.

References NotImplemented.

Referenced by squarePulse::value().

Here is the caller graph for this function:

◆ write()

void write ( Ostream & os ) const

virtual

Write data to dictionary stream.

Implements Function1< scalar >.

Definition at line 68 of file squarePulse.C.

References Foam::writeEntry().

Here is the call graph for this function:

◆ operator=()

void operator= ( const squarePulse & )

delete

Disallow default bitwise assignment.

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

src/OpenFOAM/primitives/functions/Function1/squarePulse/squarePulse.H
src/OpenFOAM/primitives/functions/Function1/squarePulse/squarePulse.C
src/OpenFOAM/primitives/functions/Function1/squarePulse/squarePulseI.H

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ squarePulse()

◆ ~squarePulse()

Member Function Documentation

◆ TypeName()

◆ value()

◆ integral()

◆ write()

◆ operator=()