Skip to content

Commit 259a878

Browse files
authored
doc/edits to some basic example files (#149)
1 parent 233eee0 commit 259a878

File tree

3 files changed

+7
-7
lines changed

3 files changed

+7
-7
lines changed

examples/00-basic/01-basic_operators.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@
5959
mm_op = dpf.Operator("min_max_fc")
6060
mm_op.inputs.connect(norm_op.outputs)
6161

62-
# Finally, get the value of the maximum displacement
62+
# Finally, get the value of the maximum displacement.
6363
field_max = mm_op.outputs.field_max()
6464
print(field_max)
6565
print(field_max.data)
@@ -78,8 +78,8 @@
7878
# Create the displacement operator directly from the ``results`` property:
7979
disp_op = model.results.displacement()
8080

81-
# Out of convenience, the operators module contains available operators
82-
# Those operators can be created in chain to create a workflow in one line
81+
# Out of convenience, the ``operators`` module contains available operators.
82+
# These operators can be chained to create a workflow in one line.
8383
from ansys.dpf.core import operators
8484

8585
mm_op = operators.min_max.min_max_fc(operators.math.norm_fc(disp_op))
@@ -103,7 +103,7 @@
103103

104104
###############################################################################
105105
# Instead of using a ``model`` class instance, use a
106-
# datasources object directly. The ``DataSources`` constructor input is a path.
106+
# ``DdataSources`` object directly. The ``DataSources`` constructor input is a path.
107107
ds = dpf.DataSources(examples.static_rst)
108108
print(examples.static_rst)
109109

examples/00-basic/02-basic_field_containers.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
Field and Field Containers Overview
55
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
66
In DPF, the field is the main simulation data container. During a numerical
7-
simulations, result data is defined by values associated to entities
7+
simulation, result data is defined by values associated to entities
88
(scoping). These entities are a subset of a model (support).
99
1010
Because field data is always associated to its scoping and support,
@@ -14,7 +14,7 @@
1414
tensor, stress or strain equivalent, or minimum or maximum
1515
over time of any result. A field can be defined on a complete model or
1616
on only certain entities of the model based on its scoping. The data
17-
is stored as a vector of double values and each elementary entity has
17+
is stored as a vector of double values, and each elementary entity has
1818
a number of components. For example, a displacement will have three
1919
components, and a symmetrical stress matrix will have six components.
2020

examples/00-basic/07-use_result_helpers.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
44
Use Result Helpers to Load Custom Data
55
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
6-
The ``Result`` class, which are instances created by the ``Model``, give
6+
The ``Result`` class, which is an instance created by the ``Model``, gives
77
access to helpers for requesting results on specific mesh and time scopings.
88
With these helpers, working on a custom spatial and temporal subset of the
99
model is straightforward.

0 commit comments

Comments
 (0)