Skip to content

Commit 666d8e8

Browse files
hugtalbotbakpaul
authored andcommitted
update README
1 parent d40d019 commit 666d8e8

1 file changed

Lines changed: 5 additions & 3 deletions

File tree

stlib/README.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,11 @@
1010
| Data* | Attribute of a Component or a Node |
1111
| Prefab | A Sofa.Node assembling of Objects and Nodes (a "fragment" of a scene) |
1212
| Geometry | A prefab that describe shapes with their topologies (i.e a shape with its space descritization and its associated connectivity) |
13-
| Entity | A physical prefab that represents real-world properties and behaviors used in a simulation. An entity should always have a geometry.|
13+
| Entity | A physical prefab that represents real-world properties and behaviors used in a simulation. An entity should always have a geometry but includes neither a linear solver nor an integration scheme.|
1414
| Parameters | Every prefab has a set of parameters. These parameters can contain data, links, callable or being composed of other parameters. Some of them can be optional. ~~Must inherit from `stlib.core.baseParameter.BaseParameter` and have a `@dataclasses.dataclass` decorator~~. Must have a `@stlib.parameters` decorator. |
1515

16-
*Defined in SOFA documentation [here](https://www.sofa-framework.org/doc/using-sofa/terminology).
16+
\*Defined in SOFA documentation [here](https://www.sofa-framework.org/doc/using-sofa/terminology).
17+
1718

1819
## Concepts & Structure
1920

@@ -25,7 +26,8 @@ We introduce two different concepts, Prefab and Parameters:
2526

2627
We introduce two types of Prefabs:
2728
- __Geometry__: A prefab that describes shapes with their topologies (i.e a shape with its space discretization and its associated connectivity).
28-
- __Entity__: A physical prefab that represents real-world properties and behaviors used in a simulation. An entity should always have a geometry.
29+
- __Entity__: A physical prefab that represents real-world properties and behaviors used in a simulation. An entity should always have a geometry but includes neither a linear solver nor an integration scheme.
30+
2931

3032
## Usage
3133

0 commit comments

Comments
 (0)