A templated cosine function, with support for offset etc. More...
Public Member Functions | |
TypeName ("cosine") | |
void | operator= (const Cosine< Type > &)=delete |
No copy assignment. More... | |
Cosine (const word &entryName, const dictionary &dict, const objectRegistry *obrPtr=nullptr) | |
Construct from entry name, dictionary and optional registry. More... | |
Cosine (const Cosine< Type > &rhs) | |
Copy construct. More... | |
virtual tmp< Function1< Type > > | clone () const |
Construct and return a clone. More... | |
virtual | ~Cosine ()=default |
Destructor. More... | |
virtual Type | value (const scalar t) const |
Return value for time t. More... | |
Public Member Functions inherited from Sine< Type > | |
TypeName ("sine") | |
void | operator= (const Sine< Type > &)=delete |
No copy assignment. More... | |
Sine (const word &entryName, const dictionary &dict, const objectRegistry *obrPtr=nullptr) | |
Construct from entry name, dictionary and optional registry. More... | |
Sine (const Sine< Type > &rhs) | |
Copy construct. More... | |
virtual | ~Sine ()=default |
Destructor. More... | |
virtual void | userTimeToTime (const Time &t) |
Convert time. 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< Type > | |
TypeName ("Function1") declareRunTimeSelectionTable(autoPtr | |
Runtime type information. More... | |
Function1 (const word &entryName, const objectRegistry *obrPtr=nullptr) | |
Construct from entry name. More... | |
Function1 (const word &entryName, const dictionary &dict, const objectRegistry *obrPtr=nullptr) | |
Construct from entry name, (unused) dictionary and optional registry. More... | |
Function1 (const Function1< Type > &rhs) | |
Copy construct. 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 tmp< Field< Type > > | value (const scalarField &x) const |
Return value as a function of (scalar) independent variable. More... | |
virtual Type | integrate (const scalar x1, const scalar x2) const |
Integrate between two (scalar) values. More... | |
virtual tmp< Field< Type > > | integrate (const scalarField &x1, const scalarField &x2) const |
Integrate between two (scalar) values. 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 word & | name () const noexcept |
The name of the entry. More... | |
const objectRegistry * | whichDb () 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 objectRegistry & | obr () const |
Return the object registry. More... | |
bool | isTime () const noexcept |
Return true if this function was created with the time database. More... | |
const Time & | time () const |
Return the time database. More... | |
template<class MeshType > | |
const MeshType & | mesh (const word ®ionName=word::null) const |
Return the mesh database if this Function1 was created using a mesh. More... | |
Public Member Functions inherited from refCount | |
constexpr | refCount () noexcept |
Default construct, initializing count to 0. More... | |
int | use_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< Type > | |
typedef Type | returnType |
The return type. More... | |
Static Public Member Functions inherited from Function1< Type > | |
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. More... | |
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. More... | |
static autoPtr< Function1< Type > > | New (const word &entryName, const dictionary &dict, const objectRegistry *obrPtr=nullptr, const bool mandatory=true) |
Selector, without fallback redirection. More... | |
static autoPtr< Function1< Type > > | NewIfPresent (const word &entryName, const dictionary &dict, const word &redirectType, const objectRegistry *obrPtr=nullptr) |
An optional selector, with fallback redirection. More... | |
static autoPtr< Function1< Type > > | NewIfPresent (const word &entryName, const dictionary &dict, const objectRegistry *obrPtr=nullptr) |
An optional selector, without fallback redirection. More... | |
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. More... | |
Public Attributes inherited from Function1< Type > | |
Function1 | |
dictionary | |
const word & | entryName |
const word const dictionary & | dict |
const word const dictionary const objectRegistry * | obrPtr |
const word const dictionary const objectRegistry | entryName |
const word const dictionary const objectRegistry | dict |
const word const dictionary const objectRegistry | obrPtr |
Protected Member Functions inherited from Sine< Type > | |
scalar | cycle (const scalar t) const |
The cycle: (freq * time) or (time / period) More... | |
scalar | cosForm (const scalar t) const |
Calculated cos value at time t. More... | |
scalar | sinForm (const scalar t) const |
Calculated sin value at time t. More... | |
scalar | squareForm (const scalar t, const scalar posFrac) const |
Calculated square value at time t. More... | |
Type | cosValue (const scalar t) const |
Return value for time t, using cos form. More... | |
Type | sinValue (const scalar t) const |
Return value for time t, using sin form. More... | |
Type | squareValue (const scalar t, const scalar posFrac) const |
Return value for time t, using square form. More... | |
Protected Member Functions inherited from Function1< Type > | |
void | operator= (const Function1< Type > &)=delete |
No copy assignment. More... | |
Protected Member Functions inherited from function1Base | |
void | operator= (const function1Base &)=delete |
No copy assignment. More... | |
Protected Attributes inherited from Sine< Type > | |
scalar | t0_ |
Start-time for the function. More... | |
autoPtr< Function1< scalar > > | amplitude_ |
Scalar amplitude of the function (optional) More... | |
autoPtr< Function1< scalar > > | period_ |
Period of the function (or specify frequency) More... | |
autoPtr< Function1< scalar > > | frequency_ |
Frequency of the function (or specify period) More... | |
autoPtr< Function1< Type > > | scale_ |
Scaling factor for the function. More... | |
autoPtr< Function1< Type > > | level_ |
Level to add to the scaled function. More... | |
Protected Attributes inherited from function1Base | |
const word | name_ |
Name of entry. More... | |
const objectRegistry * | obrPtr_ |
Pointer to an object registry. More... | |
A templated cosine function, with support for offset etc.
The wave period can be specified directly
Or it can be specified by the frequency
where
= | Description | Units | |
= | Amplitude | - | |
= | Frequency | [1/s] | |
= | Period | [s] | |
= | Type scale factor | - | |
= | Type offset level | - | |
= | Time | [s] | |
= | Start time offset | [s] |
The dictionary specification would typically resemble this:
entry1 { type cosine; frequency 10; amplitude 0.1; // A scalar Function1 scale 2e-6; level 2e-6; } entry2 { type cosine; 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: cosine | 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 |
|
inline |
|
virtualdefault |
Destructor.
TypeName | ( | "cosine" | ) |
Construct and return a clone.
Reimplemented from Sine< Type >.
|
inlinevirtual |
Return value for time t.
Reimplemented from Sine< Type >.
Definition at line 260 of file Cosine.H.
References Sine< Type >::cosValue().
Copyright © 2011-2018 OpenFOAM | OPENFOAM® is a registered trademark of OpenCFD Ltd.