Structure Class Reference

The central data structure for SoS.

This class stores all data required to process and post-process Statistics on Structures.

Structure is a Listener. It implements callback functions listening to changes at DataObjectContainer instances.

See also

insertData

eraseData ...

Data displayed in the user interface is stored in an unique instance of Structure. Access this unique instance:

database = sos.database()

Data stored:

• Reference mesh (referenceMesh())
• Field and scalar data (nodeData(), elementData(), scalarData())
• Field-MOPs (FMOPData())
• Random fields (RandomFieldData())
• Macros (chunkManager())

The object returned by scalarData() is a DataObjectContainer. DataObjectContainer provides read access to all DataObjects contained in the filter. DataObjectContainer provides database write access, allowing the insertion of a DataObject.

Each DataObject contained in a DataObjectContainer is uniquely identified by a DataObjectKey. A DataObjectKey consists of a quantity identifier and a design identifier.

Note

The same syntax applies to all data types: node, element and scalar data.

[Scalar/Node/Element]DataObject read access script examples.

Access specific DataObject.

key = sos.DataObjectKey("1", "yield_stress")
dataObject1 = sos.database().scalarData().find(key)
dataObject2 = sos.database().scalarData().find("2","yield_stress")
value = dataObject1.getData()[0]

Note

Individual DataObjects, as returned by the find() method, are a lightweight class (C++ pointer). No (field) data is copied when assigning DataObjects.

Using filters. Every filter method returns another filter, for an easy combination of filters.

filterAllSamples = sos.database().scalarData().samples()
dataObjects = filterAllSamples.generateVector()
dataObject1 = dataObjects[0]
filterYieldStress = filterAllSamples.filterQuantity("yield_*", true) #true: match regular expression
designs = filterYieldStress.designs() #a vector of design identifiers
filterResponses = sos.database().nodeData().filterQuantity("thickness").responses()
filterCoPs = filterResponses.filterDesign("CoP", true) #true: match regular expression

[Scalar/Node/Element]DataObject write access script examples. Not exhaustive, also see DataObjectContainer.

dataObject = sos.createScalarDataObject(6.626e-34)
key = sos.DataObjectKey("1", "quantum")
sos.database().scalarData().insert(key, dataObject)

sos.database().scalarData().erase(key)
sos.database().scalarData().eraseQuantity("quantum")
sos.database().scalarData().eraseDesign("1")

Access Field-MOP (also see FMOPContainer, FMOPGroup)

fmop = sos.database().FMOPData().findFMOP("thickness",sos.ELEMENT_DATA)
inputSensitivites = fmop.inputCoP() #vector of input sensitivities (CoPs)

inputs = fmop.inputIdentsVector()

Access Random Field (also see RandomFieldContainer, RandomFieldGroup)

rf = sos.database().RandomFieldContainer().findGroup("thickness", sos.ELEMENT_DATA)
totalExplainedVariation = rf.getVariationTotal()
amplitudeIdentifier1 = rf.amplitudeIdent(0)

Access/Create/Load Macros (also see MacroManager)

\note Currently only Lua macros are supported.

print(sos.database().macroManager().size()) #empty by default, stores user created macros
functionEvaluateFieldMOP = sos.defaultMacroManager().get("elementApproxFieldMOP")
print(functionEvaluateFieldMOP.getMacro())
myFunction = sos.MacroFunction()
myFunction.setIdent("helloWorld")
myFunction.setShortName("print 'Hello world!'")
myFunction.setMacro("print('Hello world!')")
sos.database().MacroManager().add(myFunction)
sos.loadMacros()
sos_macros.helloWorld() #prints 'Hello world!'