Database.initialiseScriptedResults


initialiseScriptedResults(entity, [component], [packedDim], [unitSet], [denominatatorUnitSet])

Set a value of 0.0 for every node, element node, and element gauss point. This is useful if you don't want to receive an error message when asking for scripted results that have not yet been set - instead the answer will be 0.0. The entity may be given either as a name, or as an index previously registered using addScriptedResultsEntity. If the entity is given as a string and does not already exist, it will be created. If the component does not already exist within the given entity, a new component is created within the given entity. If you do not wish to initialise all values to 0.0, but still wish to create a component and assign its dimensionality and units, use createScriptedResults instead

entitystring or long Name or index of results entity
componentstring Name of results component
packedDimoptional integer Dimensionality of the component
unitSetoptional Unit set The name or ID of a Unit set, or a pointer to a UnitSet object. Customised (e.g. codified) unit set for this result - default is database units
denominatatorUnitSetoptional Unit set The name or ID of a Unit set, or a pointer to a UnitSet object. Customised (e.g. codified) unit set for the optional extra 'per length/area' denominator - default is database units
Return valuenone 

See also flushScriptedResults setScriptedResultsEntity specifyResultsUpdateScript setNodeScriptedResults setGaussScriptedResults setScriptedResults packDimensionality

Back to Database

Back to Overview