GlobalSystemMatrixExporter
Export the global system matrix from a linear solver.
Target: SofaMatrix
namespace: sofa::component::linearsystem
parents:
- BaseSimulationExporter
Data
| Name | Description | Default value |
|---|---|---|
| name | object name | unnamed |
| printLog | if true, emits extra messages at runtime. | 0 |
| tags | list of the subsets the objet belongs to | |
| bbox | this object bounding box | |
| componentState | The state of the component among (Dirty, Valid, Undefined, Loading, Invalid). | Undefined |
| listening | if true, handle the events, otherwise ignore the events | 0 |
| filename | Path or filename where to export the data. If missing the name of the component is used. | |
| exportEveryNumberOfSteps | export file only at specified number of steps (0=disable, default=0) | 0 |
| exportAtBegin | export file before the simulation starts, once the simulation is initialized (default=false) | 0 |
| exportAtEnd | export file when the simulation is over and cleanup is called, i.e. just before deleting the simulation (default=false) | 0 |
| enable | Enable or disable the component. (default=true) | 1 |
| format | File format | txt |
| precision | Number of digits used to write an entry of the matrix, default is 6 | 6 |
Links
| Name | Description | Destination type name |
|---|---|---|
| context | Graph Node containing this object (or BaseContext::getDefault() if no graph is used) | BaseContext |
| slaves | Sub-objects used internally by this object | BaseObject |
| master | nullptr for regular objects, or master object for which this object is one sub-objects | BaseObject |
| linearSystem | Linear system used to export its matrix | BaseMatrixLinearSystem |
Examples
GlobalSystemMatrixExporter.scn
<Node name="root" dt="0.02" gravity="0 -10 0">
<RequiredPlugin name="Sofa.Component.Constraint.Projective"/> <!-- Needed to use components [FixedProjectiveConstraint] -->
<RequiredPlugin name="Sofa.Component.LinearSolver.Direct"/> <!-- Needed to use components [SparseLDLSolver] -->
<RequiredPlugin name="Sofa.Component.LinearSolver.Iterative"/> <!-- Needed to use components [CGLinearSolver] -->
<RequiredPlugin name="Sofa.Component.Mass"/> <!-- Needed to use components [UniformMass] -->
<RequiredPlugin name="Sofa.Component.ODESolver.Backward"/> <!-- Needed to use components [EulerImplicitSolver] -->
<RequiredPlugin name="Sofa.Component.SolidMechanics.FEM.Elastic"/> <!-- Needed to use components [HexahedronFEMForceField] -->
<RequiredPlugin name="Sofa.Component.StateContainer"/> <!-- Needed to use components [MechanicalObject] -->
<RequiredPlugin name="Sofa.Component.Topology.Container.Grid"/> <!-- Needed to use components [RegularGridTopology] -->
<RequiredPlugin name="Sofa.Component.Visual"/> <!-- Needed to use components [VisualStyle] -->
<RequiredPlugin name="SofaMatrix"/> <!-- Needed to use components [GlobalSystemMatrixExporter] -->
<VisualStyle displayFlags="showBehaviorModels showForceFields" />
<Node name="M1">
<EulerImplicitSolver name="odesolver" printLog="false" rayleighStiffness="0.1" rayleighMass="0.1" />
<MatrixLinearSystem template="CompressedRowSparseMatrixMat3x3d"/>
<SparseLDLSolver printLog="false" template="CompressedRowSparseMatrixMat3x3d"/>
<GlobalSystemMatrixExporter exportEveryNumberOfSteps="1" filename="global_matrix_ldl" printLog="true" format="txt" precision="12"/>
<MechanicalObject />
<UniformMass vertexMass="1"/>
<RegularGridTopology nx="4" ny="4" nz="10" xmin="-9" xmax="-6" ymin="0" ymax="3" zmin="0" zmax="9" />
<FixedProjectiveConstraint indices="0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15" />
<HexahedronFEMForceField name="FEM" youngModulus="4000" poissonRatio="0.3" method="large" />
</Node>
<Node name="M2">
<EulerImplicitSolver name="odesolver" printLog="false" rayleighStiffness="0.1" rayleighMass="0.1" />
<CGLinearSolver template="GraphScattered" iterations="25" tolerance="1e-5" threshold="1e-5"/>
<!-- The following exporter will warn that the matrix cannot be exported because the matrix is not assembled -->
<GlobalSystemMatrixExporter exportEveryNumberOfSteps="1" filename="global_matrix_cg" printLog="true"/>
<MechanicalObject />
<UniformMass vertexMass="1"/>
<RegularGridTopology nx="4" ny="4" nz="10" xmin="-6" xmax="-3" ymin="0" ymax="3" zmin="0" zmax="9" />
<FixedProjectiveConstraint indices="0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15" />
<HexahedronFEMForceField name="FEM" youngModulus="4000" poissonRatio="0.3" method="large" />
</Node>
<!-- Node containing 2 objects under a single linear solver -->
<Node name="M3">
<EulerImplicitSolver name="odesolver" printLog="false" rayleighStiffness="0.1" rayleighMass="0.1" />
<MatrixLinearSystem template="CompressedRowSparseMatrixMat3x3d"/>
<SparseLDLSolver printLog="false" template="CompressedRowSparseMatrixMat3x3d"/>
<GlobalSystemMatrixExporter exportEveryNumberOfSteps="1" filename="global_matrix_ldl_2objects" printLog="true" format="jpg"/>
<Node name="N1">
<MechanicalObject />
<UniformMass vertexMass="1"/>
<RegularGridTopology nx="4" ny="4" nz="10" xmin="-3" xmax="0" ymin="0" ymax="3" zmin="0" zmax="9" />
<FixedProjectiveConstraint indices="0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15" />
<HexahedronFEMForceField name="FEM" youngModulus="4000" poissonRatio="0.3" method="large" />
</Node>
<Node name="N2">
<MechanicalObject />
<UniformMass vertexMass="1"/>
<RegularGridTopology nx="4" ny="4" nz="10" xmin="0" xmax="3" ymin="0" ymax="3" zmin="0" zmax="9" />
<FixedProjectiveConstraint indices="0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15" />
<HexahedronFEMForceField name="FEM" youngModulus="4000" poissonRatio="0.3" method="large" />
</Node>
</Node>
</Node>
def createScene(root_node):
root = root_node.addChild('root', dt="0.02", gravity="0 -10 0")
root.addObject('RequiredPlugin', name="Sofa.Component.Constraint.Projective")
root.addObject('RequiredPlugin', name="Sofa.Component.LinearSolver.Direct")
root.addObject('RequiredPlugin', name="Sofa.Component.LinearSolver.Iterative")
root.addObject('RequiredPlugin', name="Sofa.Component.Mass")
root.addObject('RequiredPlugin', name="Sofa.Component.ODESolver.Backward")
root.addObject('RequiredPlugin', name="Sofa.Component.SolidMechanics.FEM.Elastic")
root.addObject('RequiredPlugin', name="Sofa.Component.StateContainer")
root.addObject('RequiredPlugin', name="Sofa.Component.Topology.Container.Grid")
root.addObject('RequiredPlugin', name="Sofa.Component.Visual")
root.addObject('RequiredPlugin', name="SofaMatrix")
root.addObject('VisualStyle', displayFlags="showBehaviorModels showForceFields")
m1 = root.addChild('M1')
m1.addObject('EulerImplicitSolver', name="odesolver", printLog="false", rayleighStiffness="0.1", rayleighMass="0.1")
m1.addObject('MatrixLinearSystem', template="CompressedRowSparseMatrixMat3x3d")
m1.addObject('SparseLDLSolver', printLog="false", template="CompressedRowSparseMatrixMat3x3d")
m1.addObject('GlobalSystemMatrixExporter', exportEveryNumberOfSteps="1", filename="global_matrix_ldl", printLog="true", format="txt", precision="12")
m1.addObject('MechanicalObject', )
m1.addObject('UniformMass', vertexMass="1")
m1.addObject('RegularGridTopology', nx="4", ny="4", nz="10", xmin="-9", xmax="-6", ymin="0", ymax="3", zmin="0", zmax="9")
m1.addObject('FixedProjectiveConstraint', indices="0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15")
m1.addObject('HexahedronFEMForceField', name="FEM", youngModulus="4000", poissonRatio="0.3", method="large")
m2 = root.addChild('M2')
m2.addObject('EulerImplicitSolver', name="odesolver", printLog="false", rayleighStiffness="0.1", rayleighMass="0.1")
m2.addObject('CGLinearSolver', template="GraphScattered", iterations="25", tolerance="1e-5", threshold="1e-5")
m2.addObject('GlobalSystemMatrixExporter', exportEveryNumberOfSteps="1", filename="global_matrix_cg", printLog="true")
m2.addObject('MechanicalObject', )
m2.addObject('UniformMass', vertexMass="1")
m2.addObject('RegularGridTopology', nx="4", ny="4", nz="10", xmin="-6", xmax="-3", ymin="0", ymax="3", zmin="0", zmax="9")
m2.addObject('FixedProjectiveConstraint', indices="0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15")
m2.addObject('HexahedronFEMForceField', name="FEM", youngModulus="4000", poissonRatio="0.3", method="large")
m3 = root.addChild('M3')
m3.addObject('EulerImplicitSolver', name="odesolver", printLog="false", rayleighStiffness="0.1", rayleighMass="0.1")
m3.addObject('MatrixLinearSystem', template="CompressedRowSparseMatrixMat3x3d")
m3.addObject('SparseLDLSolver', printLog="false", template="CompressedRowSparseMatrixMat3x3d")
m3.addObject('GlobalSystemMatrixExporter', exportEveryNumberOfSteps="1", filename="global_matrix_ldl_2objects", printLog="true", format="jpg")
n1 = M3.addChild('N1')
n1.addObject('MechanicalObject', )
n1.addObject('UniformMass', vertexMass="1")
n1.addObject('RegularGridTopology', nx="4", ny="4", nz="10", xmin="-3", xmax="0", ymin="0", ymax="3", zmin="0", zmax="9")
n1.addObject('FixedProjectiveConstraint', indices="0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15")
n1.addObject('HexahedronFEMForceField', name="FEM", youngModulus="4000", poissonRatio="0.3", method="large")
n2 = M3.addChild('N2')
n2.addObject('MechanicalObject', )
n2.addObject('UniformMass', vertexMass="1")
n2.addObject('RegularGridTopology', nx="4", ny="4", nz="10", xmin="0", xmax="3", ymin="0", ymax="3", zmin="0", zmax="9")
n2.addObject('FixedProjectiveConstraint', indices="0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15")
n2.addObject('HexahedronFEMForceField', name="FEM", youngModulus="4000", poissonRatio="0.3", method="large")