Commit 1288b4ec authored by Bob Obara's avatar Bob Obara Committed by Kitware Robot

Merge topic 'updatingSMTKDocs' into release

2cd6ba21 ENH: Minor Documentation Updates
Acked-by: Kitware Robot's avatarKitware Robot <kwrobot@kitware.com>
Acked-by: John Tourtellott's avatarJohn Tourtellott <john.tourtellott@kitware.com>
Merge-request: !1582
parents 2ed5250a 2cd6ba21
...@@ -4,10 +4,10 @@ Template File Syntax (Reference) ...@@ -4,10 +4,10 @@ Template File Syntax (Reference)
File Layout File Layout
----------- -----------
All attribute template and instance files must contain the All attribute template and instance files must contain the
<SMTK_AttributeSystem> XML element. The following table shows the XML <SMTK_AttributeResource> XML element. The following table shows the XML
Attributes that can be included in this XML Element. Attributes that can be included in this XML Element.
.. list-table:: XML Attributes for <SMTK_AttributeSystem> Element .. list-table:: XML Attributes for <SMTK_AttributeResource> Element
:widths: 10 40 :widths: 10 40
:header-rows: 1 :header-rows: 1
...@@ -17,7 +17,7 @@ Attributes that can be included in this XML Element. ...@@ -17,7 +17,7 @@ Attributes that can be included in this XML Element.
* - Version * - Version
- Integer value that indicates the SMTK attribute format (Required) - Integer value that indicates the SMTK attribute format (Required)
Valid Values are 1 or 2 Current value is 3 (latest version)
This element can contain the following optional children XML Elements: This element can contain the following optional children XML Elements:
......
.. _smtk-attribute-sys: .. _smtk-attribute-sys:
----------------------- -----------------------
SMTK's Attribute System SMTK's Attribute Resource
----------------------- -----------------------
General Description General Description
...@@ -12,7 +12,7 @@ General Description ...@@ -12,7 +12,7 @@ General Description
:width: 60% :width: 60%
SMTK's first major component is its attribute modeling system, SMTK's first major component is its attribute modeling resource,
which provides a way to model and represent non-geometric which provides a way to model and represent non-geometric
simulation data such as material properties, boundary conditions, simulation data such as material properties, boundary conditions,
and solver parameters. and solver parameters.
......
This diff is collapsed.
Key Concepts Key Concepts
============ ============
Like the model system, the mesh system is composed of C++ classes, Like the model resource, the mesh resource is composed of C++ classes,
also accessible in Python, and is based on concepts from MOAB_, also accessible in Python, and is based on concepts from MOAB_,
which it uses internally. The paradigm we use facilitates an which it uses internally. The paradigm we use facilitates an
interaction with meshes and their components in aggregate, interaction with meshes and their components in aggregate,
......
.. _smtk-mesh-sys: .. _smtk-mesh-sys:
------------------ ------------------
SMTK's Mesh System SMTK's Mesh Resource
------------------ ------------------
SMTK's third major component is its meshing system, SMTK's third major component is its meshing resource,
which allows you to interact with multiple mesh generators which allows you to interact with multiple mesh generators
and associate one or more meshes with each geometric model and associate one or more meshes with each geometric model
entity. entity.
......
Key Concepts Key Concepts
============ ============
Like the attribute resource, the model system is composed of C++ classes, Like the attribute resource, the model resource is composed of C++ classes,
also accessible in Python, whose instances perform the following functions: also accessible in Python, whose instances perform the following functions:
:smtk:`Resource <smtk::model::Resource>` :smtk:`Resource <smtk::model::Resource>`
......
.. _smtk-model-sys: .. _smtk-model-sys:
----------------------------- -----------------------------
SMTK's Geometric Model System SMTK's Geometric Model Resource
----------------------------- -----------------------------
SMTK's second major component is its geometric modeling system, SMTK's second major component is its geometric modeling resource,
which allows you to interact with multiple modeling sessions which allows you to interact with multiple modeling sessions
that may each interact with different solid modeling kernels. that may each interact with different solid modeling kernels.
......
...@@ -12,13 +12,13 @@ These subsystems are: ...@@ -12,13 +12,13 @@ These subsystems are:
basic provenance information about versions of data on disk. basic provenance information about versions of data on disk.
Each file is a *resource*, which may hold a resource of *resource components*; Each file is a *resource*, which may hold a resource of *resource components*;
the *resource manager* assembles resources together for processing into a simulation input. the *resource manager* assembles resources together for processing into a simulation input.
* The **attribute** system, which provides a way to specify how information should be * The **attribute** resource, which provides a way to specify how information should be
organized for scientific and engineering workflows, accept that information from users, organized for scientific and engineering workflows, accept that information from users,
and ensure that it is consistent with the specification. and ensure that it is consistent with the specification.
* The **model** system, which provides geometric modeling and allows you to tie * The **model** resource, which provides geometric modeling and allows you to tie
information from the attribute resource to geometric entities (e.g., assign boundary conditions information from the attribute resource to geometric entities (e.g., assign boundary conditions
in the attribute resource to particular boundaries on a CAD model). in the attribute resource to particular boundaries on a CAD model).
* The **mesh** system, which can manipulate meshes of geometric models; it provides a way * The **mesh** resource, which can manipulate meshes of geometric models; it provides a way
to propagate simulation attribute information from model entities onto meshes. to propagate simulation attribute information from model entities onto meshes.
It also provides a way to run external mesh creation tools on the model. It also provides a way to run external mesh creation tools on the model.
* The **operation** system, which provides an interface to * The **operation** system, which provides an interface to
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment