Skip to content

Commit 50c71c8

Browse files
committed
DOCS: Update user component files.
1 parent 53bfcc6 commit 50c71c8

File tree

9 files changed

+14
-17
lines changed

9 files changed

+14
-17
lines changed

docs/user/components/materials/Elasticity.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ Implements `Material`.
3131
* `description`=\<str\>: Descriptive label for material (deprecated in v5.0; will be removed in v6.0).
3232
- **default value**: ''
3333
- **current value**: '', from {default}
34-
- **validator**: <function validateDescription at 0x10608f2e0>
34+
- **validator**: <function validateDescription at 0x10480b2e0>
3535
* `label`=\<str\>: Name of label for material. Currently only 'material-id' is allowed.
3636
- **default value**: 'material-id'
3737
- **current value**: 'material-id', from {default}
@@ -50,7 +50,6 @@ Example of setting `Elasticity` Pyre properties and facilities in a parameter fi
5050
:::{code-block} cfg
5151
[pylithapp.problem.materials.mat_elastic]
5252
label_value = 4
53-
description = Upper crust elastic material
5453
use_body_force = False
5554
bulk_rheology = pylith.materials.IsotropicLinearElasticity
5655

docs/user/components/materials/IncompressibleElasticity.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ Implements `Material`.
3131
* `description`=\<str\>: Descriptive label for material (deprecated in v5.0; will be removed in v6.0).
3232
- **default value**: ''
3333
- **current value**: '', from {default}
34-
- **validator**: <function validateDescription at 0x10608f2e0>
34+
- **validator**: <function validateDescription at 0x10480b2e0>
3535
* `label`=\<str\>: Name of label for material. Currently only 'material-id' is allowed.
3636
- **default value**: 'material-id'
3737
- **current value**: 'material-id', from {default}
@@ -49,7 +49,6 @@ Example of setting `IncompressibleElasticity` Pyre properties and facilities in
4949

5050
:::{code-block} cfg
5151
[pylithapp.problem.materials.mat_incompelastic]
52-
description = Upper crust incompressible elastic material
5352
label_value = 3
5453
use_body_force = True
5554
bulk_rheology = pylith.materials.IsotropicLinearIncompElasticity

docs/user/components/materials/Poroelasticity.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ Implements `Material`.
3131
* `description`=\<str\>: Descriptive label for material (deprecated in v5.0; will be removed in v6.0).
3232
- **default value**: ''
3333
- **current value**: '', from {default}
34-
- **validator**: <function validateDescription at 0x10608f2e0>
34+
- **validator**: <function validateDescription at 0x10480b2e0>
3535
* `label`=\<str\>: Name of label for material. Currently only 'material-id' is allowed.
3636
- **default value**: 'material-id'
3737
- **current value**: 'material-id', from {default}
@@ -55,7 +55,6 @@ Example of setting `Poroelasticity` Pyre properties and facilities in a paramete
5555

5656
:::{code-block} cfg
5757
[pylithapp.problem.materials.mat_poroelastic]
58-
description = Upper crust poroelastic material
5958
label_value = 3
6059
use_body_force = True
6160
use_source_density = False

docs/user/components/meshio/MeshIOPetsc.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ Implements `MeshIOObj`.
2424
* `filename`=\<str\>: Name of mesh file for reading with PETSc.
2525
- **default value**: ''
2626
- **current value**: '', from {default}
27-
* `gmsh_mark_vertices`=\<bool\>: Gmsh file marks faces, edges, and vertices rather than just faces.
27+
* `gmsh_mark_recursive`=\<bool\>: Gmsh file marks faces, edges, and vertices rather than just faces (3D) or edges (2D).
2828
- **default value**: False
2929
- **current value**: False, from {default}
3030
* `options_prefix`=\<str\>: Name of PETSc options prefix for this mesh.

docs/user/components/meshio/OutputPhysics.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -45,8 +45,8 @@ Example of setting `OutputPhysics` Pyre properties and facilities in a parameter
4545
:::{code-block} cfg
4646
[observer]
4747
# Skip two time steps between output.
48-
output_trigger = pylith.meshio.OutputTriggerStep
49-
output_trigger.num_skip = 2
48+
trigger = pylith.meshio.OutputTriggerStep
49+
trigger.num_skip = 2
5050

5151
# Write output to HDF5 file with name `boundary_xpos.h5`.
5252
writer = pylith.meshio.DataWriterHDF5

docs/user/components/meshio/OutputSolnBoundary.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ Implements `OutputSoln`.
2929
* `label`=\<str\>: Name of label identifier for external boundary.
3030
- **default value**: ''
3131
- **current value**: '', from {default}
32-
- **validator**: <function validateLabel at 0x10816d800>
32+
- **validator**: <function validateLabel at 0x104835e40>
3333
* `label_value`=\<int\>: Value of label identifier for external boundary (tag of physical group in Gmsh files).
3434
- **default value**: 1
3535
- **current value**: 1, from {default}
@@ -53,8 +53,8 @@ data_fields = [displacement]
5353
label = boundary_xpos
5454

5555
# Skip two time steps between output.
56-
output_trigger = pylith.meshio.OutputTriggerStep
57-
output_trigger.num_skip = 2
56+
trigger = pylith.meshio.OutputTriggerStep
57+
trigger.num_skip = 2
5858

5959
# Write output to HDF5 file with name `boundary_xpos.h5`.
6060
writer = pylith.meshio.DataWriterHDF5

docs/user/components/meshio/OutputSolnDomain.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -44,8 +44,8 @@ Example of setting `OutputSolnDomain` Pyre properties and facilities in a parame
4444
data_fields = [displacement]
4545

4646
# Skip two time steps between output.
47-
output_trigger = pylith.meshio.OutputTriggerStep
48-
output_trigger.num_skip = 2
47+
trigger = pylith.meshio.OutputTriggerStep
48+
trigger.num_skip = 2
4949

5050
# Write output to HDF5 file with name `domain.h5`.
5151
writer = pylith.meshio.DataWriterHDF5

docs/user/components/meshio/OutputSolnPoints.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -55,8 +55,8 @@ reader = pylith.meshio.PointsList
5555
reader.filename = stations.txt
5656

5757
# Skip two time steps between output.
58-
output_trigger = pylith.meshio.OutputTriggerStep
59-
output_trigger.num_skip = 2
58+
trigger = pylith.meshio.OutputTriggerStep
59+
trigger.num_skip = 2
6060

6161
# Write output to HDF5 file with name `domain.h5`.
6262
writer = pylith.meshio.DataWriterHDF5

docs/user/components/topology/MeshImporter.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Implements `MeshGenerator`.
1313
* `distributor`: Distributes mesh among processes.
1414
- **current value**: 'mesh_distributor', from {default}
1515
- **configurable as**: mesh_distributor, distributor
16-
* `reader`: Reader for mesh files.
16+
* `reader`: Reader for mesh file.
1717
- **current value**: 'meshioascii', from {default}
1818
- **configurable as**: meshioascii, reader
1919
* `refiner`: Performs uniform global mesh refinement after distribution among processes (default is no refinement).

0 commit comments

Comments
 (0)