A templated square-wave function with support for offset, etc. More...

#include <Square.H>

Inheritance diagram for Square< Type >:

Collaboration diagram for Square< Type >:

Public Member Functions
	TypeName ("square")
void	operator= (const Square< Type > &)=delete
	No copy assignment.
	Square (const word &entryName, const dictionary &dict, const objectRegistry *obrPtr=nullptr)
	Construct from entry name, dictionary and optional registry.
	Square (const Square< Type > &rhs)
	Copy construct.
virtual tmp< Function1< Type > >	clone () const
	Return a clone.
virtual	~Square ()=default
	Destructor.
virtual Type	value (const scalar t) const
	Return value for time t.
virtual void	writeData (Ostream &os) const
	Write in dictionary format.
virtual void	writeEntries (Ostream &os) const
	Write coefficient entries in dictionary format.
const::Foam::word	typeName (Function1Types::Square< scalar >::typeName_())
int	debug (::Foam::debug::debugSwitch(Function1Types::Square< scalar >::typeName_(), 0))
const::Foam::word	typeName (Function1Types::Square< vector >::typeName_())
int	debug (::Foam::debug::debugSwitch(Function1Types::Square< vector >::typeName_(), 0))
const::Foam::word	typeName (Function1Types::Square< sphericalTensor >::typeName_())
int	debug (::Foam::debug::debugSwitch(Function1Types::Square< sphericalTensor >::typeName_(), 0))
const::Foam::word	typeName (Function1Types::Square< symmTensor >::typeName_())
int	debug (::Foam::debug::debugSwitch(Function1Types::Square< symmTensor >::typeName_(), 0))
const::Foam::word	typeName (Function1Types::Square< tensor >::typeName_())
int	debug (::Foam::debug::debugSwitch(Function1Types::Square< tensor >::typeName_(), 0))
Public Member Functions inherited from Sine< Type >
	TypeName ("sine")
void	operator= (const Sine< Type > &)=delete
	No copy assignment.
	Sine (const word &entryName, const dictionary &dict, const objectRegistry *obrPtr=nullptr)
	Construct from entry name, dictionary and optional registry.
	Sine (const Sine< Type > &rhs)
	Copy construct.
virtual	~Sine ()=default
	Destructor.
virtual void	userTimeToTime (const Time &t)
	Convert time.
virtual Type	integrate (const scalar x1, const scalar x2) const
	Integrate between two (scalar) values.
const::Foam::word	typeName (Function1Types::Sine< scalar >::typeName_())
int	debug (::Foam::debug::debugSwitch(Function1Types::Sine< scalar >::typeName_(), 0))
const::Foam::word	typeName (Function1Types::Sine< vector >::typeName_())
int	debug (::Foam::debug::debugSwitch(Function1Types::Sine< vector >::typeName_(), 0))
const::Foam::word	typeName (Function1Types::Sine< sphericalTensor >::typeName_())
int	debug (::Foam::debug::debugSwitch(Function1Types::Sine< sphericalTensor >::typeName_(), 0))
const::Foam::word	typeName (Function1Types::Sine< symmTensor >::typeName_())
int	debug (::Foam::debug::debugSwitch(Function1Types::Sine< symmTensor >::typeName_(), 0))
const::Foam::word	typeName (Function1Types::Sine< tensor >::typeName_())
int	debug (::Foam::debug::debugSwitch(Function1Types::Sine< tensor >::typeName_(), 0))
Public Member Functions inherited from Function1< Type >
virtual const word &	type () const
	Function1 (const word &entryName, const objectRegistry *obrPtr=nullptr)
	Construct from entry name.
	Function1 (const word &entryName, const dictionary &dict, const objectRegistry *obrPtr=nullptr)
	Construct from entry name, (unused) dictionary and optional registry.
	Function1 (const Function1< Type > &rhs)
	Copy construct.
virtual	~Function1 ()=default
	Destructor.
virtual bool	constant () const
	Is value constant (i.e. independent of x).
virtual bool	good () const
	Can function be evaluated?
virtual tmp< Field< Type > >	value (const scalarField &x) const
	Return value as a function of (scalar) independent variable.
virtual tmp< Field< Type > >	integrate (const scalarField &x1, const scalarField &x2) const
	Integrate between two (scalar) values.
const::Foam::word	typeName (Function1< label >::typeName_())
int	debug (::Foam::debug::debugSwitch(Function1< label >::typeName_(), 0))
Function1< label >::dictionaryConstructorTableType *	dictionaryConstructorTablePtr_ (nullptr)
std::unique_ptr< Function1< label >::dictionaryConstructorCompatTableType >	dictionaryConstructorCompatTablePtr_ (nullptr)
Function1< label >::dictionaryConstructorCompatTableType &	dictionaryConstructorCompatTable ()
void	dictionaryConstructorTablePtr_construct (bool load)
Function1< label >::dictionaryConstructorPtr	dictionaryConstructorTable (const::Foam::word &k)
const::Foam::word	typeName (Function1< scalar >::typeName_())
int	debug (::Foam::debug::debugSwitch(Function1< scalar >::typeName_(), 0))
Function1< scalar >::dictionaryConstructorTableType *	dictionaryConstructorTablePtr_ (nullptr)
std::unique_ptr< Function1< scalar >::dictionaryConstructorCompatTableType >	dictionaryConstructorCompatTablePtr_ (nullptr)
Function1< scalar >::dictionaryConstructorCompatTableType &	dictionaryConstructorCompatTable ()
void	dictionaryConstructorTablePtr_construct (bool load)
Function1< scalar >::dictionaryConstructorPtr	dictionaryConstructorTable (const::Foam::word &k)
const::Foam::word	typeName (Function1< vector >::typeName_())
int	debug (::Foam::debug::debugSwitch(Function1< vector >::typeName_(), 0))
Function1< vector >::dictionaryConstructorTableType *	dictionaryConstructorTablePtr_ (nullptr)
std::unique_ptr< Function1< vector >::dictionaryConstructorCompatTableType >	dictionaryConstructorCompatTablePtr_ (nullptr)
Function1< vector >::dictionaryConstructorCompatTableType &	dictionaryConstructorCompatTable ()
void	dictionaryConstructorTablePtr_construct (bool load)
Function1< vector >::dictionaryConstructorPtr	dictionaryConstructorTable (const::Foam::word &k)
const::Foam::word	typeName (Function1< sphericalTensor >::typeName_())
int	debug (::Foam::debug::debugSwitch(Function1< sphericalTensor >::typeName_(), 0))
Function1< sphericalTensor >::dictionaryConstructorTableType *	dictionaryConstructorTablePtr_ (nullptr)
std::unique_ptr< Function1< sphericalTensor >::dictionaryConstructorCompatTableType >	dictionaryConstructorCompatTablePtr_ (nullptr)
Function1< sphericalTensor >::dictionaryConstructorCompatTableType &	dictionaryConstructorCompatTable ()
void	dictionaryConstructorTablePtr_construct (bool load)
Function1< sphericalTensor >::dictionaryConstructorPtr	dictionaryConstructorTable (const::Foam::word &k)
const::Foam::word	typeName (Function1< symmTensor >::typeName_())
int	debug (::Foam::debug::debugSwitch(Function1< symmTensor >::typeName_(), 0))
Function1< symmTensor >::dictionaryConstructorTableType *	dictionaryConstructorTablePtr_ (nullptr)
std::unique_ptr< Function1< symmTensor >::dictionaryConstructorCompatTableType >	dictionaryConstructorCompatTablePtr_ (nullptr)
Function1< symmTensor >::dictionaryConstructorCompatTableType &	dictionaryConstructorCompatTable ()
void	dictionaryConstructorTablePtr_construct (bool load)
Function1< symmTensor >::dictionaryConstructorPtr	dictionaryConstructorTable (const::Foam::word &k)
const::Foam::word	typeName (Function1< tensor >::typeName_())
int	debug (::Foam::debug::debugSwitch(Function1< tensor >::typeName_(), 0))
Function1< tensor >::dictionaryConstructorTableType *	dictionaryConstructorTablePtr_ (nullptr)
std::unique_ptr< Function1< tensor >::dictionaryConstructorCompatTableType >	dictionaryConstructorCompatTablePtr_ (nullptr)
Function1< tensor >::dictionaryConstructorCompatTableType &	dictionaryConstructorCompatTable ()
void	dictionaryConstructorTablePtr_construct (bool load)
Function1< tensor >::dictionaryConstructorPtr	dictionaryConstructorTable (const::Foam::word &k)
const::Foam::word	typeName (Function1< scalarField >::typeName_())
int	debug (::Foam::debug::debugSwitch(Function1< scalarField >::typeName_(), 0))
Function1< scalarField >::dictionaryConstructorTableType *	dictionaryConstructorTablePtr_ (nullptr)
std::unique_ptr< Function1< scalarField >::dictionaryConstructorCompatTableType >	dictionaryConstructorCompatTablePtr_ (nullptr)
Function1< scalarField >::dictionaryConstructorCompatTableType &	dictionaryConstructorCompatTable ()
void	dictionaryConstructorTablePtr_construct (bool load)
Function1< scalarField >::dictionaryConstructorPtr	dictionaryConstructorTable (const::Foam::word &k)
Public Member Functions inherited from function1Base
	function1Base (const word &entryName, const objectRegistry *obrPtr=nullptr)
	Construct from entry name and optional registry.
	function1Base (const word &entryName, const dictionary &dict, const objectRegistry *obrPtr=nullptr)
	Construct from entry name, dictionary (unused) and optional registry.
	function1Base (const function1Base &rhs)
	Copy construct.
virtual	~function1Base ()
	Destructor.
const word &	name () const noexcept
	The name of the entry.
const objectRegistry *	whichDb () const noexcept
	Return the associated registry or nullptr.
void	resetDb (const objectRegistry *obrPtr=nullptr) noexcept
	Reset the associated objectRegistry.
void	resetDb (const objectRegistry &db) noexcept
	Reset the associated objectRegistry.
const objectRegistry &	obr () const
	Return the object registry.
bool	isTime () const noexcept
	Return true if this function was created with the time database.
const Time &	time () const
	Return the time database.
template<class MeshType>
const MeshType &	mesh (const word &regionName=word::null) const
	Return the mesh database if this Function1 was created using a mesh.
Public Member Functions inherited from refCount
constexpr	refCount () noexcept
	Default construct, initializing count to 0.
int	use_count () const noexcept
	Return the current reference count.
bool	unique () const noexcept
	Return true if the reference count is zero.
void	operator++ () noexcept
	Increment the reference count.
void	operator++ (int) noexcept
	Increment the reference count.
void	operator-- () noexcept
	Decrement the reference count.
void	operator-- (int) noexcept
	Decrement the reference count.

Additional Inherited Members
Public Types inherited from Function1< Type >
typedef Type	returnType
	The return type.
typedef autoPtr< Function1 >(*	dictionaryConstructorPtr) (const word &entryName, const dictionary &dict, const objectRegistry *obrPtr)
	Declare runtime constructor selection table.
typedef ::Foam::HashTable< dictionaryConstructorPtr, ::Foam::word, ::Foam::Hash<::Foam::word > >	dictionaryConstructorTableType
typedef ::Foam::HashTable< std::pair<::Foam::word, int >, ::Foam::word, ::Foam::Hash<::Foam::word > >	dictionaryConstructorCompatTableType
Static Public Member Functions inherited from Function1< Type >
static const char *	typeName_ ()
	Runtime type information.
static dictionaryConstructorCompatTableType &	dictionaryConstructorCompatTable ()
static void	dictionaryConstructorTablePtr_construct (bool load)
static dictionaryConstructorPtr	dictionaryConstructorTable (const ::Foam::word &k)
template<class Derived>
static tmp< Function1< Type > >	Clone (const Derived &fun)
	Clone a Function1.
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.
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.
static autoPtr< Function1< Type > >	New (const word &entryName, const dictionary &dict, const objectRegistry *obrPtr=nullptr, const bool mandatory=true)
	Selector, without fallback redirection.
static autoPtr< Function1< Type > >	NewIfPresent (const word &entryName, const dictionary &dict, const word &redirectType, const objectRegistry *obrPtr=nullptr)
	An optional selector, with fallback redirection.
static autoPtr< Function1< Type > >	NewIfPresent (const word &entryName, const dictionary &dict, const objectRegistry *obrPtr=nullptr)
	An optional selector, without fallback redirection.
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)
	Selector with external storage of Function1. This also allows wildcard matches in a dictionary.
Static Public Attributes inherited from Function1< Type >
static const ::Foam::word	typeName
static int	debug
static dictionaryConstructorTableType *	dictionaryConstructorTablePtr_
static std::unique_ptr< dictionaryConstructorCompatTableType >	dictionaryConstructorCompatTablePtr_
Protected Member Functions inherited from Sine< Type >
scalar	cycle (const scalar t) const
	The cycle: (freq * time) or (time / period).
scalar	cosForm (const scalar t) const
	Calculated cos value at time t.
scalar	sinForm (const scalar t) const
	Calculated sin value at time t.
scalar	squareForm (const scalar t, const scalar posFrac) const
	Calculated square value at time t.
Type	cosValue (const scalar t) const
	Return value for time t, using cos form.
Type	sinValue (const scalar t) const
	Return value for time t, using sin form.
Type	squareValue (const scalar t, const scalar posFrac) const
	Return value for time t, using square form.
Protected Member Functions inherited from Function1< Type >
void	operator= (const Function1< Type > &)=delete
	No copy assignment.
Protected Member Functions inherited from function1Base
void	operator= (const function1Base &)=delete
	No copy assignment.
Protected Attributes inherited from Sine< Type >
scalar	t0_
	Start-time for the function.
autoPtr< Function1< scalar > >	amplitude_
	Scalar amplitude of the function (optional).
autoPtr< Function1< scalar > >	period_
	Period of the function (or specify frequency).
autoPtr< Function1< scalar > >	frequency_
	Frequency of the function (or specify period).
autoPtr< Function1< Type > >	scale_
	Scaling factor for the function.
autoPtr< Function1< Type > >	level_
	Level to add to the scaled function.
Protected Attributes inherited from function1Base
const word	name_
	Name of entry.
const objectRegistry *	obrPtr_
	Pointer to an object registry.

Detailed Description

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

A templated square-wave function with support for offset, etc.

The wave period can be specified directly

$\‍[ a square((t - t0) / p)) s + l \‍]$

Or it can be specified by the frequency

$\‍[ a square(f (t - t0)) s + l \‍]$

where

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

=	Description	Units
=	Amplitude	-
=	Frequency	[1/s]
=	Period	[s]
=	Type scale factor	-
=	Type offset level	-
=	Time	[s]
=	Start time offset	[s]
=	mark/space ratio	-

The dictionary specification would typically resemble this:

    entry1
    {
        type        square;
        frequency   10;
        amplitude   0.1;

        // A scalar Function1
        scale       2e-6;
        level       2e-6;
    }
    entry2
    {
        type        square;
        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: square	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
`mark`	Positive amount	scalar	no	1
`space`	Negative amount	scalar	no	1

Note: For slow oscillations it can be more intuitive to specify the period.

Definition at line 219 of file Square.H.

Constructor & Destructor Documentation

◆ Square() [1/2]

template<class Type>

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

Construct from entry name, dictionary and optional registry.

Definition at line 27 of file Square.C.

References dict, and Sine< Type >::Sine().

Referenced by operator=(), and Square().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Square() [2/2]

template<class Type>

Square ( const Square< Type > & rhs )

explicit

Copy construct.

Definition at line 41 of file Square.C.

References Foam::rhs(), Sine< Type >::Sine(), and Square().

Here is the call graph for this function:

◆ ~Square()

template<class Type>

virtual ~Square ( )

virtualdefault

Destructor.

Member Function Documentation

◆ TypeName()

template<class Type>

TypeName ( "square" )

◆ operator=()

template<class Type>

void operator= ( const Square< Type > & )

delete

No copy assignment.

References dict, Foam::rhs(), and Square().

Here is the call graph for this function:

◆ clone()

template<class Type>

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

inlinevirtual

Return a clone.

Reimplemented from Sine< Type >.

Definition at line 269 of file Square.H.

References Function1< Type >::Clone().

Here is the call graph for this function:

◆ value()

template<class Type>

virtual Type value ( const scalar t ) const

inlinevirtual

Return value for time t.

Reimplemented from Sine< Type >.

Definition at line 286 of file Square.H.

References Sine< Type >::squareValue().

Here is the call graph for this function:

◆ writeData()

template<class Type>

void writeData ( Ostream & os ) const

virtual

Write in dictionary format.

Reimplemented from Sine< Type >.

Definition at line 61 of file Square.C.

References name, os(), Function1< Type >::writeData(), and writeEntries().

Here is the call graph for this function:

◆ writeEntries()

template<class Type>

void writeEntries ( Ostream & os ) const

virtual

Write coefficient entries in dictionary format.

Reimplemented from Sine< Type >.

Definition at line 52 of file Square.C.

References os(), and Sine< Type >::writeEntries().

Referenced by writeData().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ typeName() [1/5]

const::Foam::word typeName ( Function1Types::Square< scalar > ::typeName_() )

◆ debug() [1/5]

int debug ( ::Foam::debug::debugSwitch(Function1Types::Square< scalar >::typeName_(), 0) )

◆ typeName() [2/5]

const::Foam::word typeName ( Function1Types::Square< vector > ::typeName_() )

◆ debug() [2/5]

int debug ( ::Foam::debug::debugSwitch(Function1Types::Square< vector >::typeName_(), 0) )

◆ typeName() [3/5]

const::Foam::word typeName ( Function1Types::Square< sphericalTensor > ::typeName_() )

◆ debug() [3/5]

int debug ( ::Foam::debug::debugSwitch(Function1Types::Square< sphericalTensor >::typeName_(), 0) )

◆ typeName() [4/5]

const::Foam::word typeName ( Function1Types::Square< symmTensor > ::typeName_() )

◆ debug() [4/5]

int debug ( ::Foam::debug::debugSwitch(Function1Types::Square< symmTensor >::typeName_(), 0) )

◆ typeName() [5/5]

const::Foam::word typeName ( Function1Types::Square< tensor > ::typeName_() )

◆ debug() [5/5]

int debug ( ::Foam::debug::debugSwitch(Function1Types::Square< tensor >::typeName_(), 0) )

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

src/OpenFOAM/primitives/functions/Function1/Square/Square.H
src/OpenFOAM/primitives/functions/Function1/Square/Square.C

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Square() [1/2]

◆ Square() [2/2]

◆ ~Square()

Member Function Documentation

◆ TypeName()

◆ operator=()

◆ clone()

◆ value()

◆ writeData()

◆ writeEntries()

◆ typeName() [1/5]

◆ debug() [1/5]

◆ typeName() [2/5]

◆ debug() [2/5]

◆ typeName() [3/5]

◆ debug() [3/5]

◆ typeName() [4/5]

◆ debug() [4/5]

◆ typeName() [5/5]

◆ debug() [5/5]