stepFunction Class Reference

A step function that is 0 before start changing to 1 for the duration and returning to 0 thereafter. More...

Inheritance diagram for stepFunction:
[legend]
Collaboration diagram for stepFunction:
[legend]

Public Member Functions

 TypeName ("step")
 Runtime type information. More...
 
 stepFunction (const word &entryName, const dictionary &dict, const objectRegistry *obrPtr=nullptr)
 Construct from entry name, dictionary and optional registry. More...
 
virtual ~stepFunction ()=default
 Destructor. More...
 
virtual scalar value (const scalar x) const
 Return value at time t. More...
 
- Public Member Functions inherited from ramp
 ramp (const word &entryName, const dictionary &dict, const objectRegistry *obrPtr=nullptr)
 Construct from entry name, dictionary and optional registry. More...
 
virtual ~ramp ()=default
 Destructor. More...
 
virtual void userTimeToTime (const Time &t)
 Convert time. More...
 
virtual scalar value (const scalar t) const =0
 Return value for time t. More...
 
virtual void writeData (Ostream &os) const
 Write in dictionary format. More...
 
virtual void writeEntries (Ostream &os) const
 Write coefficient entries in dictionary format. More...
 
- Public Member Functions inherited from Function1< scalar >
 Function1 (const word &entryName, const objectRegistry *obrPtr=nullptr)
 Construct from entry name. More...
 
 Function1 (const word &entryName, const dictionary &dict, const objectRegistry *obrPtr=nullptr)
 
 Function1 (const Function1< scalar > &rhs)
 Copy construct. More...
 
 TypeName ("Function1") declareRunTimeSelectionTable(autoPtr
 Runtime type information. More...
 
virtual tmp< Function1< scalar > > clone () const=0
 Construct and return a clone. More...
 
virtual ~Function1 ()=default
 Destructor. More...
 
virtual bool constant () const
 Is value constant (i.e. independent of x) More...
 
virtual bool good () const
 Can function be evaluated? More...
 
virtual scalar value (const scalar x) const
 Return value as a function of (scalar) independent variable. More...
 
virtual tmp< Field< scalar > > value (const scalarField &x) const
 Return value as a function of (scalar) independent variable. More...
 
virtual scalar integrate (const scalar x1, const scalar x2) const
 Integrate between two (scalar) values. More...
 
virtual tmp< Field< scalar > > integrate (const scalarField &x1, const scalarField &x2) const
 Integrate between two (scalar) values. More...
 
virtual void writeData (Ostream &os) const
 Write in dictionary format. More...
 
virtual void writeEntries (Ostream &os) const
 Write coefficient entries in dictionary format. More...
 
- Public Member Functions inherited from function1Base
 function1Base (const word &entryName, const objectRegistry *obrPtr=nullptr)
 Construct from entry name and optional registry. More...
 
 function1Base (const word &entryName, const dictionary &dict, const objectRegistry *obrPtr=nullptr)
 Construct from entry name, dictionary (unused) and optional registry. More...
 
 function1Base (const function1Base &rhs)
 Copy construct. More...
 
virtual ~function1Base ()
 Destructor. More...
 
const wordname () const noexcept
 The name of the entry. More...
 
const objectRegistrywhichDb () const noexcept
 Return the associated registry or nullptr. More...
 
void resetDb (const objectRegistry *obrPtr=nullptr) noexcept
 Reset the associated objectRegistry. More...
 
void resetDb (const objectRegistry &db) noexcept
 Reset the associated objectRegistry. More...
 
const objectRegistryobr () const
 Return the object registry. More...
 
bool isTime () const noexcept
 Return true if this function was created with the time database. More...
 
const Timetime () const
 Return the time database. More...
 
template<class MeshType >
const MeshType & mesh (const word &regionName=word::null) const
 Return the mesh database if this Function1 was created using a mesh. More...
 
virtual void userTimeToTime (const Time &t)
 Convert time. More...
 
- Public Member Functions inherited from refCount
constexpr refCount () noexcept
 Default construct, initializing count to 0. More...
 
int count () const noexcept
 Return the current reference count. More...
 
bool unique () const noexcept
 Return true if the reference count is zero. More...
 
void operator++ () noexcept
 Increment the reference count. More...
 
void operator++ (int) noexcept
 Increment the reference count. More...
 
void operator-- () noexcept
 Decrement the reference count. More...
 
void operator-- (int) noexcept
 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 &entryName, const dictionary &dict, const word &redirectType, const objectRegistry *obrPtr=nullptr, const bool mandatory=true)
 Selector, with fallback redirection. More...
 
static autoPtr< Function1< scalar > > New (const word &entryName, const dictionary &dict, const objectRegistry *obrPtr=nullptr, const bool mandatory=true)
 Selector, without fallback redirection. More...
 
static refPtr< Function1< scalar > > New (HashPtrTable< Function1< scalar > > &cache, const word &entryName, const dictionary &dict, enum keyType::option matchOpt=keyType::LITERAL, const objectRegistry *obrPtr=nullptr, const bool mandatory=true)
 
static autoPtr< Function1< scalar > > 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. More...
 
static autoPtr< Function1< scalar > > NewIfPresent (const word &entryName, const dictionary &dict, const word &redirectType=word::null, const objectRegistry *obrPtr=nullptr)
 An optional selector. More...
 
- Public Attributes inherited from Function1< scalar >
 Function1
 
 dictionary
 
const wordentryName
 
const word const dictionary const objectRegistry entryName
 
const word const dictionarydict
 
const word const dictionary const objectRegistry dict
 
const word const dictionary const objectRegistryobrPtr
 
const word const dictionary const objectRegistry obrPtr
 
- Protected Member Functions inherited from ramp
scalar linearRamp (const scalar t) const
 
- Protected Member Functions inherited from Function1< scalar >
void operator= (const Function1< scalar > &)=delete
 No copy assignment. More...
 
- Protected Member Functions inherited from function1Base
void operator= (const function1Base &)=delete
 No copy assignment. More...
 
- Protected Attributes inherited from ramp
scalar start_
 Start-time of the ramp function. More...
 
scalar duration_
 Duration of the ramp function. More...
 
- Protected Attributes inherited from function1Base
const word name_
 Name of entry. More...
 
const objectRegistryobrPtr_
 Pointer to an object registry. More...
 

Detailed Description

A step function that is 0 before start changing to 1 for the duration and returning to 0 thereafter.

See also
Foam::Function1Types::ramp
Source files

Definition at line 56 of file stepFunction.H.

Constructor & Destructor Documentation

◆ stepFunction()

stepFunction ( const word entryName,
const dictionary dict,
const objectRegistry obrPtr = nullptr 
)

Construct from entry name, dictionary and optional registry.

Definition at line 43 of file stepFunction.C.

◆ ~stepFunction()

virtual ~stepFunction ( )
virtualdefault

Destructor.

Member Function Documentation

◆ TypeName()

TypeName ( "step"  )

Runtime type information.

◆ value()

Foam::scalar value ( const scalar  x) const
inlinevirtual

Return value at time t.

Implements ramp.

Definition at line 32 of file stepFunctionI.H.

References ramp::duration_, ramp::start_, and stepFunction::value().

Referenced by stepFunction::value().

Here is the call graph for this function:
Here is the caller graph for this function:

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