FreeFOAM The Cross-Platform CFD Toolkit
Hosted by SourceForge:
Get FreeFOAM at SourceForge.net.
            Fast, secure and Free Open Source software downloads

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

#include <lagrangianIntermediate/DataEntry.H>


Detailed Description

template<class Type>
class Foam::DataEntry< Type >

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

Source files

Definition at line 64 of file DataEntry.H.

Inheritance diagram for DataEntry< Type >:
Collaboration diagram for DataEntry< Type >:

List of all members.

Public Member Functions

 TypeName ("DataEntry") declareRunTimeSelectionTable(autoPtr
 Runtime type information.
 DataEntry (const word &entryName)
 Construct from entry name.
 DataEntry (const DataEntry< Type > &de)
 Copy constructor.
virtual  ~DataEntry ()
 Destructor.
const word &  name () const
 Return the name of the entry.
virtual Type  value (const scalar x) const =0
 Return value as a function of (scalar) independent variable.
virtual Type  integrate (const scalar x1, const scalar x2) const =0
 Integrate between two (scalar) values.

Static Public Member Functions

static autoPtr< DataEntry< Type > >  New (const word &entryName, const dictionary &dict)
 Selector.

Public Attributes

 DataEntry
 dictionary
const word &  entryName
const word Istream &  is
const word Istream  entryName
const word Istream  is

Protected Attributes

const word  name_
 Name of entry.

Friends

Ostream &  operator (Ostream &, const DataEntry< Type > &)
 Ostream Operator.

Constructor & Destructor Documentation

DataEntry ( const word &   entryName  )

Construct from entry name.

DataEntry ( const DataEntry< Type > &   de  )

Copy constructor.

~DataEntry (  ) [virtual]

Destructor.

Definition at line 47 of file DataEntry.C.


Member Function Documentation

TypeName ( "DataEntry< Type >"    )

Runtime type information.

Declare runtime constructor selection table

Foam::autoPtr< Foam::DataEntry< Type > > New ( const word &   entryName,
const dictionary &   dict  
) [static]

Selector.

Definition at line 32 of file NewDataEntry.C.

References Foam::exit(), Foam::FatalError, FatalErrorIn, dictionary::lookup(), and Foam::nl.

const Foam::word & name (  ) const

Return the name of the entry.

Definition at line 54 of file DataEntry.C.

virtual Type value ( const scalar   x  ) const [pure virtual]

Return value as a function of (scalar) independent variable.

Implemented in Constant< Type >, polynomial, and Table< Type >.

virtual Type integrate ( const scalar   x1,
const scalar   x2  
) const [pure virtual]

Integrate between two (scalar) values.

Implemented in Constant< Type >, polynomial, and Table< Type >.


Friends And Related Function Documentation

Ostream& operator ( Ostream &   ,
const DataEntry< Type > &    
) [friend]

Ostream Operator.


Member Data Documentation

const word name_ [protected]

Name of entry.

Definition at line 77 of file DataEntry.H.

Referenced by Table< Type >::Table().

Definition at line 89 of file DataEntry.H.

Definition at line 89 of file DataEntry.H.

const word& entryName

Definition at line 89 of file DataEntry.H.

const word Istream& is

Definition at line 89 of file DataEntry.H.

Definition at line 89 of file DataEntry.H.

const word Istream is

Definition at line 89 of file DataEntry.H.


The documentation for this class was generated from the following files:
  • src/lagrangian/intermediate/submodels/IO/DataEntry/DataEntry/DataEntry.H
  • src/lagrangian/intermediate/submodels/IO/DataEntry/DataEntry/DataEntry.C
  • src/lagrangian/intermediate/submodels/IO/DataEntry/DataEntry/NewDataEntry.C