Neutral¶
-
class
Neutral
¶ Neutral: Base class for all MOOSE classes. Providesaccess functions for housekeeping fields and operations, messagetraversal, and so on.
-
parentMsg
()¶ (destination message field) Message from Parent Element(s)
-
setThis
()¶ (destination message field) Assigns field value.
-
getThis
()¶ (destination message field) Requests field value. The requesting Element must provide a handler for the returned value.
-
setName
()¶ (destination message field) Assigns field value.
-
getName
()¶ (destination message field) Requests field value. The requesting Element must provide a handler for the returned value.
-
getMe
()¶ (destination message field) Requests field value. The requesting Element must provide a handler for the returned value.
-
getParent
()¶ (destination message field) Requests field value. The requesting Element must provide a handler for the returned value.
-
getChildren
()¶ (destination message field) Requests field value. The requesting Element must provide a handler for the returned value.
-
getPath
()¶ (destination message field) Requests field value. The requesting Element must provide a handler for the returned value.
-
getClassName
()¶ (destination message field) Requests field value. The requesting Element must provide a handler for the returned value.
-
setNumData
()¶ (destination message field) Assigns field value.
-
getNumData
()¶ (destination message field) Requests field value. The requesting Element must provide a handler for the returned value.
-
setNumField
()¶ (destination message field) Assigns field value.
-
getNumField
()¶ (destination message field) Requests field value. The requesting Element must provide a handler for the returned value.
-
getIdValue
()¶ (destination message field) Requests field value. The requesting Element must provide a handler for the returned value.
-
getIndex
()¶ (destination message field) Requests field value. The requesting Element must provide a handler for the returned value.
-
getFieldIndex
()¶ (destination message field) Requests field value. The requesting Element must provide a handler for the returned value.
-
setTick
()¶ (destination message field) Assigns field value.
-
getTick
()¶ (destination message field) Requests field value. The requesting Element must provide a handler for the returned value.
-
getDt
()¶ (destination message field) Requests field value. The requesting Element must provide a handler for the returned value.
-
getValueFields
()¶ (destination message field) Requests field value. The requesting Element must provide a handler for the returned value.
-
getSourceFields
()¶ (destination message field) Requests field value. The requesting Element must provide a handler for the returned value.
-
getDestFields
()¶ (destination message field) Requests field value. The requesting Element must provide a handler for the returned value.
-
getMsgOut
()¶ (destination message field) Requests field value. The requesting Element must provide a handler for the returned value.
-
getMsgIn
()¶ (destination message field) Requests field value. The requesting Element must provide a handler for the returned value.
-
getNeighbors
()¶ (destination message field) Requests field value. The requesting Element must provide a handler for the returned value.
-
getMsgDests
()¶ (destination message field) Requests field value. The requesting Element must provide a handler for the returned value.
-
getMsgDestFunctions
()¶ (destination message field) Requests field value. The requesting Element must provide a handler for the returned value.
-
getIsA
()¶ (destination message field) Requests field value. The requesting Element must provide a handler for the returned value.
-
childOut
¶ int (source message field) Message to child Elements
-
this
¶ Neutral (value field) Access function for entire object
-
name
¶ string (value field) Name of object
-
me
¶ ObjId (value field) ObjId for current object
-
parent
¶ ObjId (value field) Parent ObjId for current object
-
children
¶ vector<Id> (value field) vector of ObjIds listing all children of current object
-
path
¶ string (value field) text path for object
-
className
¶ string (value field) Class Name of object
-
numData
¶ unsigned int (value field) # of Data entries on Element.Note that on a FieldElement this does NOT refer to field entries,but to the number of DataEntries on the parent of the FieldElement.
-
numField
¶ unsigned int (value field) For a FieldElement: number of entries of self.For a regular Element: One.
-
idValue
¶ unsigned int (value field) Object id of self, converted to an unsigned int.
-
index
¶ unsigned int (value field) For a FieldElement: Object index of parent.For a regular Element: Object index (dataId) of self.
-
fieldIndex
¶ unsigned int (value field) For a FieldElement: field Index of self.For a regular Element: zero.
-
tick
¶ int (value field) Clock tick for this Element for periodic execution in the main simulation event loop. A default is normally assigned, based on object class, but one can override to any value between 0 and 19. Assigning to -1 means that the object is disabled and will not be called during simulation execution The actual timestep (dt) belonging to a clock tick is defined by the Clock object.
-
dt
¶ double (value field) Timestep used for this Element. Zero if not scheduled.
-
valueFields
¶ vector<string> (value field) List of all value fields on Element.These fields are accessed through the assignment operations in the Python interface.These fields may also be accessed as functions through the set<FieldName> and get<FieldName> commands.
-
sourceFields
¶ vector<string> (value field) List of all source fields on Element, that is fields that can act as message sources.
-
destFields
¶ vector<string> (value field) List of all destination fields on Element, that is, fieldsthat are accessed as Element functions.
-
msgOut
¶ vector<ObjId> (value field) Messages going out from this Element
-
msgIn
¶ vector<ObjId> (value field) Messages coming in to this Element
-
neighbors
¶ string,vector<Id> (lookup field) Ids of Elements connected this Element on specified field.
-
msgDests
¶ string,vector<ObjId> (lookup field) ObjIds receiving messages from the specified SrcFinfo
-
msgDestFunctions
¶ string,vector<string> (lookup field) Matching function names for each ObjId receiving a msg from the specified SrcFinfo
-
isA
¶ string,bool (lookup field) Returns true if the current object is derived from the specified the specified class
-