Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
function1Base Class Reference

Top level data entry class for use in dictionaries. Provides a mechanism to specify a variable as a certain type, e.g. constant or time varying, and provide functions to return the (interpolated) value, and integral between limits. More...

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

Public Member Functions

 function1Base (const word &entryName)
 Construct from entry name. More...
 
 function1Base (const word &entryName, const dictionary &dict)
 Construct from entry name and dictionary. More...
 
 function1Base (const function1Base &rhs)
 Copy construct. More...
 
virtual ~function1Base ()=default
 Destructor. More...
 
const word & name () const
 The name of the entry. More...
 
virtual void convertTimeBase (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...
 

Protected Member Functions

void operator= (const function1Base &)=delete
 No copy assignment. More...
 

Protected Attributes

const word name_
 Name of entry. More...
 

Detailed Description

Top level data entry class for use in dictionaries. Provides a mechanism to specify a variable as a certain type, e.g. constant or time varying, and provide functions to return the (interpolated) value, and integral between limits.

Extends the Function1 class by adding autoMap and rMap functions

Source files

Definition at line 58 of file function1Base.H.

Constructor & Destructor Documentation

◆ function1Base() [1/3]

function1Base ( const word &  entryName)
explicit

Construct from entry name.

Definition at line 33 of file function1Base.C.

◆ function1Base() [2/3]

function1Base ( const word &  entryName,
const dictionary &  dict 
)

Construct from entry name and dictionary.

Definition at line 41 of file function1Base.C.

◆ function1Base() [3/3]

function1Base ( const function1Base &  rhs)
explicit

Copy construct.

Definition at line 51 of file function1Base.C.

◆ ~function1Base()

virtual ~function1Base ( )
virtualdefault

Destructor.

Member Function Documentation

◆ operator=()

void operator= ( const function1Base &  )
protecteddelete

No copy assignment.

◆ name()

const word& name ( ) const
inline

The name of the entry.

Definition at line 99 of file function1Base.H.

References function1Base::name_.

◆ convertTimeBase()

void convertTimeBase ( const Time &  t)
virtual

Convert time.

Definition at line 60 of file function1Base.C.

Member Data Documentation

◆ name_

const word name_
protected

Name of entry.

Definition at line 67 of file function1Base.H.

Referenced by function1Base::name().

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