Skip to content

HyperelasticityFEMForceField

Hyperelasticity

Vec1d,Edge

Templates:

  • Vec1d,Edge

Target: Sofa.Component.SolidMechanics.FEM.HyperElastic

namespace: sofa::component::solidmechanics::fem::hyperelastic

parents:

  • FEMForceField

Data

Name Description Default value
name object name unnamed
printLog if true, emits extra messages at runtime. 0
tags list of the subsets the object 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
rayleighStiffness Rayleigh damping - stiffness matrix coefficient 0
nbThreads If not yet initialized, the main task scheduler is initialized with this number of threads. 0 corresponds to the number of available cores on the CPU. -n (minus) corresponds to the number of available cores on the CPU minus the provided number. 0
taskSchedulerType Type of task scheduler to use. _default
Multithreading
computeForceStrategy The compute strategy used to compute the forces. - parallel: The algorithm is executed in parallel - sequenced: The algorithm is executed sequentially
computeForceDerivStrategy The compute strategy used to compute the forces derivatives. - parallel: The algorithm is executed in parallel - sequenced: The algorithm is executed sequentially
Visualization
elementSpace When rendering, the space between elements 0.125
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 BaseComponent
master nullptr for regular objects, or master object for which this object is one sub-objects BaseComponent
mechanicalStates List of mechanical states to which this component is associated BaseMechanicalState
mstate MechanicalState used by this component MechanicalState<Vec1d>
topology Link to a topology BaseMeshTopology
material Link to the material containing the constitutive law HyperelasticMaterial<Vec1d>

Vec2d,Quad...

Templates:

  • Vec2d,Quad
  • Vec2d,Triangle

Target: Sofa.Component.SolidMechanics.FEM.HyperElastic

namespace: sofa::component::solidmechanics::fem::hyperelastic

parents:

  • FEMForceField

Data

Name Description Default value
name object name unnamed
printLog if true, emits extra messages at runtime. 0
tags list of the subsets the object 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
rayleighStiffness Rayleigh damping - stiffness matrix coefficient 0
nbThreads If not yet initialized, the main task scheduler is initialized with this number of threads. 0 corresponds to the number of available cores on the CPU. -n (minus) corresponds to the number of available cores on the CPU minus the provided number. 0
taskSchedulerType Type of task scheduler to use. _default
Multithreading
computeForceStrategy The compute strategy used to compute the forces. - parallel: The algorithm is executed in parallel - sequenced: The algorithm is executed sequentially
computeForceDerivStrategy The compute strategy used to compute the forces derivatives. - parallel: The algorithm is executed in parallel - sequenced: The algorithm is executed sequentially
Visualization
elementSpace When rendering, the space between elements 0.125
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 BaseComponent
master nullptr for regular objects, or master object for which this object is one sub-objects BaseComponent
mechanicalStates List of mechanical states to which this component is associated BaseMechanicalState
mstate MechanicalState used by this component MechanicalState<Vec2d>
topology Link to a topology BaseMeshTopology
material Link to the material containing the constitutive law HyperelasticMaterial<Vec2d>

Vec3d,Hexahedron...

Templates:

  • Vec3d,Hexahedron
  • Vec3d,Tetrahedron

Target: Sofa.Component.SolidMechanics.FEM.HyperElastic

namespace: sofa::component::solidmechanics::fem::hyperelastic

parents:

  • FEMForceField

Data

Name Description Default value
name object name unnamed
printLog if true, emits extra messages at runtime. 0
tags list of the subsets the object 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
rayleighStiffness Rayleigh damping - stiffness matrix coefficient 0
nbThreads If not yet initialized, the main task scheduler is initialized with this number of threads. 0 corresponds to the number of available cores on the CPU. -n (minus) corresponds to the number of available cores on the CPU minus the provided number. 0
taskSchedulerType Type of task scheduler to use. _default
Multithreading
computeForceStrategy The compute strategy used to compute the forces. - parallel: The algorithm is executed in parallel - sequenced: The algorithm is executed sequentially
computeForceDerivStrategy The compute strategy used to compute the forces derivatives. - parallel: The algorithm is executed in parallel - sequenced: The algorithm is executed sequentially
Visualization
elementSpace When rendering, the space between elements 0.125
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 BaseComponent
master nullptr for regular objects, or master object for which this object is one sub-objects BaseComponent
mechanicalStates List of mechanical states to which this component is associated BaseMechanicalState
mstate MechanicalState used by this component MechanicalState<Vec3d>
topology Link to a topology BaseMeshTopology
material Link to the material containing the constitutive law HyperelasticMaterial<Vec3d>

Examples

HyperelasticityFEMForceField.scn

<?xml version="1.0"?>
<Node name="root" dt="0.01" gravity="0 -9.81 0">
    <include href="../../../../CantileverBeam_ElementFEMForceField.xml"/>

    <ConstantSparsityPatternSystem template="CompressedRowSparseMatrix" name="A" checkIndices="false"/>
    <NaturalOrderingMethod/>
    <SparseLDLSolver name="linear_solver" template="CompressedRowSparseMatrix"/>

    <StVenantKirchhoffMaterial name="material" youngModulus="2e6" poissonRatio="0.45"/>
    <HyperelasticityFEMForceField name="FEM" template="Vec3,Hexahedron" topology="@grid"
                                  computeForceStrategy="parallel" computeForceDerivStrategy="parallel"/>
</Node>

def createScene(root_node):

   root = root_node.addChild('root', dt="0.01", gravity="0 -9.81 0")

   root.addObject('include', href="../../../../CantileverBeam_ElementFEMForceField.xml")
   root.addObject('ConstantSparsityPatternSystem', template="CompressedRowSparseMatrix", name="A", checkIndices="false")
   root.addObject('NaturalOrderingMethod', )
   root.addObject('SparseLDLSolver', name="linear_solver", template="CompressedRowSparseMatrix")
   root.addObject('StVenantKirchhoffMaterial', name="material", youngModulus="2e6", poissonRatio="0.45")
   root.addObject('HyperelasticityFEMForceField', name="FEM", template="Vec3,Hexahedron", topology="@grid", computeForceStrategy="parallel", computeForceDerivStrategy="parallel")

HyperelasticityFEMForceField.scn

<?xml version="1.0"?>
<Node name="root" dt="0.01" gravity="0 -9.81 0">
    <include href="../../../../CantileverBeam_ElementFEMForceField.xml"/>

    <CGLinearSolver iterations="250" name="linear_solver" tolerance="1.0e-12" threshold="1.0e-12" />

    <StVenantKirchhoffMaterial name="material" youngModulus="2e6" poissonRatio="0.45"/>
    <HyperelasticityFEMForceField name="FEM" template="Vec3,Hexahedron" topology="@grid"
                                  computeForceStrategy="parallel" computeForceDerivStrategy="parallel"/>

</Node>

def createScene(root_node):

   root = root_node.addChild('root', dt="0.01", gravity="0 -9.81 0")

   root.addObject('include', href="../../../../CantileverBeam_ElementFEMForceField.xml")
   root.addObject('CGLinearSolver', iterations="250", name="linear_solver", tolerance="1.0e-12", threshold="1.0e-12")
   root.addObject('StVenantKirchhoffMaterial', name="material", youngModulus="2e6", poissonRatio="0.45")
   root.addObject('HyperelasticityFEMForceField', name="FEM", template="Vec3,Hexahedron", topology="@grid", computeForceStrategy="parallel", computeForceDerivStrategy="parallel")

HyperelasticityFEMForceField.scn

<?xml version="1.0"?>
<Node name="root" dt="0.01" gravity="0 -9.81 0">
    <include href="../../../../CantileverBeam_ElementFEMForceField.xml"/>

    <ConstantSparsityPatternSystem template="CompressedRowSparseMatrix" name="A" checkIndices="false"/>
    <NaturalOrderingMethod/>
    <SparseLDLSolver name="linear_solver" template="CompressedRowSparseMatrix"/>

    <StVenantKirchhoffMaterial name="material" youngModulus="2e6" poissonRatio="0.45"/>
    <HyperelasticityFEMForceField name="FEM" template="Vec3,Hexahedron" topology="@grid"
                                  computeForceStrategy="sequenced" computeForceDerivStrategy="sequenced"/>

</Node>

def createScene(root_node):

   root = root_node.addChild('root', dt="0.01", gravity="0 -9.81 0")

   root.addObject('include', href="../../../../CantileverBeam_ElementFEMForceField.xml")
   root.addObject('ConstantSparsityPatternSystem', template="CompressedRowSparseMatrix", name="A", checkIndices="false")
   root.addObject('NaturalOrderingMethod', )
   root.addObject('SparseLDLSolver', name="linear_solver", template="CompressedRowSparseMatrix")
   root.addObject('StVenantKirchhoffMaterial', name="material", youngModulus="2e6", poissonRatio="0.45")
   root.addObject('HyperelasticityFEMForceField', name="FEM", template="Vec3,Hexahedron", topology="@grid", computeForceStrategy="sequenced", computeForceDerivStrategy="sequenced")

HyperelasticityFEMForceField.scn

<?xml version="1.0"?>
<Node name="root" dt="0.01" gravity="0 -9.81 0">
    <include href="../../../../CantileverBeam_ElementFEMForceField.xml"/>

    <CGLinearSolver iterations="250" name="linear_solver" tolerance="1.0e-12" threshold="1.0e-12" />

    <StVenantKirchhoffMaterial name="material" youngModulus="2e6" poissonRatio="0.45"/>
    <HyperelasticityFEMForceField name="FEM" template="Vec3,Hexahedron" topology="@grid"
                                  computeForceStrategy="sequenced" computeForceDerivStrategy="sequenced"/>

</Node>

def createScene(root_node):

   root = root_node.addChild('root', dt="0.01", gravity="0 -9.81 0")

   root.addObject('include', href="../../../../CantileverBeam_ElementFEMForceField.xml")
   root.addObject('CGLinearSolver', iterations="250", name="linear_solver", tolerance="1.0e-12", threshold="1.0e-12")
   root.addObject('StVenantKirchhoffMaterial', name="material", youngModulus="2e6", poissonRatio="0.45")
   root.addObject('HyperelasticityFEMForceField', name="FEM", template="Vec3,Hexahedron", topology="@grid", computeForceStrategy="sequenced", computeForceDerivStrategy="sequenced")

HyperelasticityFEMForceField.scn

<?xml version="1.0"?>
<Node name="root" dt="0.01" gravity="0 -9.81 0">
    <include href="../../../../CantileverBeam_ElementFEMForceField.xml"/>

    <ConstantSparsityPatternSystem template="CompressedRowSparseMatrix" name="A" checkIndices="false"/>
    <NaturalOrderingMethod/>
    <SparseLDLSolver name="linear_solver" template="CompressedRowSparseMatrix"/>

    <Node name="fem">
        <TetrahedronSetTopologyContainer name="Tetra_topo"/>
        <TetrahedronSetTopologyModifier name="Modifier" />
        <TetrahedronSetGeometryAlgorithms template="Vec3" name="GeomAlgo" drawTetrahedra="false"/>
        <Hexa2TetraTopologicalMapping input="@grid" output="@Tetra_topo" swapping="true"/>

        <StVenantKirchhoffMaterial name="material" youngModulus="2e6" poissonRatio="0.45"/>
        <HyperelasticityFEMForceField name="FEM" template="Vec3,Tetrahedron" topology="@Tetra_topo"
                                      computeForceStrategy="parallel" computeForceDerivStrategy="parallel"/>
    </Node>

</Node>

def createScene(root_node):

   root = root_node.addChild('root', dt="0.01", gravity="0 -9.81 0")

   root.addObject('include', href="../../../../CantileverBeam_ElementFEMForceField.xml")
   root.addObject('ConstantSparsityPatternSystem', template="CompressedRowSparseMatrix", name="A", checkIndices="false")
   root.addObject('NaturalOrderingMethod', )
   root.addObject('SparseLDLSolver', name="linear_solver", template="CompressedRowSparseMatrix")

   fem = root.addChild('fem')

   fem.addObject('TetrahedronSetTopologyContainer', name="Tetra_topo")
   fem.addObject('TetrahedronSetTopologyModifier', name="Modifier")
   fem.addObject('TetrahedronSetGeometryAlgorithms', template="Vec3", name="GeomAlgo", drawTetrahedra="false")
   fem.addObject('Hexa2TetraTopologicalMapping', input="@grid", output="@Tetra_topo", swapping="true")
   fem.addObject('StVenantKirchhoffMaterial', name="material", youngModulus="2e6", poissonRatio="0.45")
   fem.addObject('HyperelasticityFEMForceField', name="FEM", template="Vec3,Tetrahedron", topology="@Tetra_topo", computeForceStrategy="parallel", computeForceDerivStrategy="parallel")

HyperelasticityFEMForceField.scn

<?xml version="1.0"?>
<Node name="root" dt="0.01" gravity="0 -9.81 0">
    <include href="../../../../CantileverBeam_ElementFEMForceField.xml"/>

    <CGLinearSolver iterations="250" name="linear_solver" tolerance="1.0e-12" threshold="1.0e-12" />

    <Node name="fem">
        <TetrahedronSetTopologyContainer name="Tetra_topo"/>
        <TetrahedronSetTopologyModifier name="Modifier" />
        <TetrahedronSetGeometryAlgorithms template="Vec3" name="GeomAlgo" drawTetrahedra="false"/>
        <Hexa2TetraTopologicalMapping input="@grid" output="@Tetra_topo" swapping="true"/>

        <StVenantKirchhoffMaterial name="material" youngModulus="2e6" poissonRatio="0.45"/>
        <HyperelasticityFEMForceField name="FEM" template="Vec3,Tetrahedron" topology="@Tetra_topo"
                                      computeForceStrategy="parallel" computeForceDerivStrategy="parallel"/>
    </Node>

</Node>

def createScene(root_node):

   root = root_node.addChild('root', dt="0.01", gravity="0 -9.81 0")

   root.addObject('include', href="../../../../CantileverBeam_ElementFEMForceField.xml")
   root.addObject('CGLinearSolver', iterations="250", name="linear_solver", tolerance="1.0e-12", threshold="1.0e-12")

   fem = root.addChild('fem')

   fem.addObject('TetrahedronSetTopologyContainer', name="Tetra_topo")
   fem.addObject('TetrahedronSetTopologyModifier', name="Modifier")
   fem.addObject('TetrahedronSetGeometryAlgorithms', template="Vec3", name="GeomAlgo", drawTetrahedra="false")
   fem.addObject('Hexa2TetraTopologicalMapping', input="@grid", output="@Tetra_topo", swapping="true")
   fem.addObject('StVenantKirchhoffMaterial', name="material", youngModulus="2e6", poissonRatio="0.45")
   fem.addObject('HyperelasticityFEMForceField', name="FEM", template="Vec3,Tetrahedron", topology="@Tetra_topo", computeForceStrategy="parallel", computeForceDerivStrategy="parallel")

HyperelasticityFEMForceField.scn

<?xml version="1.0"?>
<Node name="root" dt="0.01" gravity="0 -9.81 0">
    <include href="../../../../CantileverBeam_ElementFEMForceField.xml"/>

    <ConstantSparsityPatternSystem template="CompressedRowSparseMatrix" name="A" checkIndices="false"/>
    <NaturalOrderingMethod/>
    <SparseLDLSolver name="linear_solver" template="CompressedRowSparseMatrix"/>

    <Node name="fem">
        <TetrahedronSetTopologyContainer name="Tetra_topo"/>
        <TetrahedronSetTopologyModifier name="Modifier" />
        <TetrahedronSetGeometryAlgorithms template="Vec3" name="GeomAlgo" drawTetrahedra="false"/>
        <Hexa2TetraTopologicalMapping input="@grid" output="@Tetra_topo" swapping="true"/>

        <StVenantKirchhoffMaterial name="material" youngModulus="2e6" poissonRatio="0.45"/>
        <HyperelasticityFEMForceField name="FEM" template="Vec3,Tetrahedron" topology="@Tetra_topo"
                                      computeForceStrategy="sequenced" computeForceDerivStrategy="sequenced"/>
    </Node>


</Node>

def createScene(root_node):

   root = root_node.addChild('root', dt="0.01", gravity="0 -9.81 0")

   root.addObject('include', href="../../../../CantileverBeam_ElementFEMForceField.xml")
   root.addObject('ConstantSparsityPatternSystem', template="CompressedRowSparseMatrix", name="A", checkIndices="false")
   root.addObject('NaturalOrderingMethod', )
   root.addObject('SparseLDLSolver', name="linear_solver", template="CompressedRowSparseMatrix")

   fem = root.addChild('fem')

   fem.addObject('TetrahedronSetTopologyContainer', name="Tetra_topo")
   fem.addObject('TetrahedronSetTopologyModifier', name="Modifier")
   fem.addObject('TetrahedronSetGeometryAlgorithms', template="Vec3", name="GeomAlgo", drawTetrahedra="false")
   fem.addObject('Hexa2TetraTopologicalMapping', input="@grid", output="@Tetra_topo", swapping="true")
   fem.addObject('StVenantKirchhoffMaterial', name="material", youngModulus="2e6", poissonRatio="0.45")
   fem.addObject('HyperelasticityFEMForceField', name="FEM", template="Vec3,Tetrahedron", topology="@Tetra_topo", computeForceStrategy="sequenced", computeForceDerivStrategy="sequenced")

HyperelasticityFEMForceField.scn

<?xml version="1.0"?>
<Node name="root" dt="0.01" gravity="0 -9.81 0">
    <include href="../../../../CantileverBeam_ElementFEMForceField.xml"/>

    <CGLinearSolver iterations="250" name="linear_solver" tolerance="1.0e-12" threshold="1.0e-12" />

    <Node name="fem">
        <TetrahedronSetTopologyContainer name="Tetra_topo"/>
        <TetrahedronSetTopologyModifier name="Modifier" />
        <TetrahedronSetGeometryAlgorithms template="Vec3" name="GeomAlgo" drawTetrahedra="false"/>
        <Hexa2TetraTopologicalMapping input="@grid" output="@Tetra_topo" swapping="true"/>

        <StVenantKirchhoffMaterial name="material" youngModulus="2e6" poissonRatio="0.45"/>
        <HyperelasticityFEMForceField name="FEM" template="Vec3,Tetrahedron" topology="@Tetra_topo"
                                      computeForceStrategy="sequenced" computeForceDerivStrategy="sequenced"/>
    </Node>

</Node>

def createScene(root_node):

   root = root_node.addChild('root', dt="0.01", gravity="0 -9.81 0")

   root.addObject('include', href="../../../../CantileverBeam_ElementFEMForceField.xml")
   root.addObject('CGLinearSolver', iterations="250", name="linear_solver", tolerance="1.0e-12", threshold="1.0e-12")

   fem = root.addChild('fem')

   fem.addObject('TetrahedronSetTopologyContainer', name="Tetra_topo")
   fem.addObject('TetrahedronSetTopologyModifier', name="Modifier")
   fem.addObject('TetrahedronSetGeometryAlgorithms', template="Vec3", name="GeomAlgo", drawTetrahedra="false")
   fem.addObject('Hexa2TetraTopologicalMapping', input="@grid", output="@Tetra_topo", swapping="true")
   fem.addObject('StVenantKirchhoffMaterial', name="material", youngModulus="2e6", poissonRatio="0.45")
   fem.addObject('HyperelasticityFEMForceField', name="FEM", template="Vec3,Tetrahedron", topology="@Tetra_topo", computeForceStrategy="sequenced", computeForceDerivStrategy="sequenced")