MOOSE - Multiscale Object Oriented Simulation Environment
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros
Variable Class Reference

#include <Variable.h>

+ Collaboration diagram for Variable:

Public Member Functions

void addMsgCallback (const Eref &e, const string &finfoName, ObjId msg, unsigned int msgLookup)
 
virtual void epSetValue (const Eref &e, double v)
 
double getValue () const
 
void setValue (double v)
 
 Variable ()
 
 Variable (const Variable &rhs)
 
virtual ~Variable ()
 

Static Public Member Functions

static const CinfoinitCinfo ()
 

Public Attributes

double value
 

Detailed Description

This class is used as FieldElement in Function. It is used as named variable of type double.

Definition at line 53 of file Variable.h.

Constructor & Destructor Documentation

Variable::Variable ( )
inline

Definition at line 56 of file Variable.h.

56  :value(0.0)
57  {
58  };
double value
Definition: Variable.h:85
Variable::Variable ( const Variable rhs)
inline

Definition at line 59 of file Variable.h.

59  : value(rhs.value)
60  {
61  ;
62  }
double value
Definition: Variable.h:85
virtual Variable::~Variable ( )
inlinevirtual

Definition at line 64 of file Variable.h.

64 {};

Member Function Documentation

void Variable::addMsgCallback ( const Eref e,
const string &  finfoName,
ObjId  msg,
unsigned int  msgLookup 
)

Definition at line 92 of file Variable.cpp.

93 {
94  /*
95  if (finfoName == "input"){
96  ObjId pa = Neutral::parent(e);
97  Function * fn = reinterpret_cast< Function *>(pa.data());
98  unsigned int varNumber = fn->addVar();
99  SetGet2<unsigned int, unsigned int>::set(msg, "fieldIndex", msgLookup, varNumber);
100  }
101  */
102 }
virtual void Variable::epSetValue ( const Eref e,
double  v 
)
inlinevirtual

Definition at line 71 of file Variable.h.

References value.

Referenced by initCinfo().

72  {
73  value = v;
74  }
double value
Definition: Variable.h:85

+ Here is the caller graph for this function:

double Variable::getValue ( ) const
inline

Definition at line 76 of file Variable.h.

References value.

Referenced by initCinfo().

77  {
78  return value;
79  }
double value
Definition: Variable.h:85

+ Here is the caller graph for this function:

const Cinfo * Variable::initCinfo ( )
static

Definition at line 52 of file Variable.cpp.

References epSetValue(), getValue(), Neutral::initCinfo(), setValue(), value, and variableCinfo.

Referenced by Function::initCinfo().

53 {
55  "value",
56  "Variable value",
59  static DestFinfo input(
60  "input",
61  "Handles incoming variable value.",
63 
64  static Finfo * variableFinfos[] = {
65  &value,
66  &input
67  };
68  static string doc[] = {
69  "Name", "Variable",
70  "Author", "Subhasis Ray",
71  "Description", "Variable for storing double values. This is used in Function class."
72  };
73  static Dinfo< Variable > dinfo;
74  static Cinfo variableCinfo("Variable",
76  variableFinfos,
77  sizeof(variableFinfos) / sizeof(Finfo*),
78  &dinfo,
79  doc,
80  sizeof(doc) / sizeof(string),
81  true // is FieldElement, not to be created directly
82  );
83  return & variableCinfo;
84 }
Definition: Dinfo.h:60
Definition: EpFunc.h:64
static const Cinfo * variableCinfo
Definition: Variable.cpp:86
void setValue(double v)
Definition: Variable.h:66
virtual void epSetValue(const Eref &e, double v)
Definition: Variable.h:71
double value
Definition: Variable.h:85
double getValue() const
Definition: Variable.h:76
static const Cinfo * initCinfo()
Definition: Neutral.cpp:16
Definition: Cinfo.h:18
Definition: Finfo.h:12

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

void Variable::setValue ( double  v)
inline

Definition at line 66 of file Variable.h.

References value.

Referenced by initCinfo().

67  {
68  value = v;
69  }
double value
Definition: Variable.h:85

+ Here is the caller graph for this function:

Member Data Documentation

double Variable::value

Definition at line 85 of file Variable.h.

Referenced by epSetValue(), getValue(), initCinfo(), and setValue().


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