Skip to content

Commit 0889741

Browse files
baagaard-usgsbaagaard-usgs
committed
DOCS: Update components in user guide.
1 parent 825611d commit 0889741

14 files changed

+150
-15
lines changed

‎docs/user/components/bc/AuxSubfieldsTimeDependent.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ The association of these functions with the auxiliary subfields is:
2525
* `initial_amplitude`: Initial amplitude, f_0(x), subfield.
2626
- **current value**: 'subfield', from {default}
2727
- **configurable as**: subfield, initial_amplitude
28-
* `rate_amplitude`: Rate amplitude, \dot{f}_1(x), subfield.
28+
* `rate_amplitude`: Rate amplitude, dot{f}_1(x), subfield.
2929
- **current value**: 'subfield', from {default}
3030
- **configurable as**: subfield, rate_amplitude
3131
* `rate_start_time`: Rate starting time, t_1(x), subfield.

‎docs/user/components/materials/AuxSubfieldsIsotropicLinearPoroelasticity.md‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,12 @@ Auxiliary subfields associated with the isotropic linear poroelastic bulk rheolo
2020
* `isotropic_permeability`: Isotropic permeability subfield.
2121
- **current value**: 'subfield', from {default}
2222
- **configurable as**: subfield, isotropic_permeability
23+
* `reference_strain`: Reference strain subfield.
24+
- **current value**: 'subfield', from {default}
25+
- **configurable as**: subfield, reference_strain
26+
* `reference_stress`: Reference stress subfield.
27+
- **current value**: 'subfield', from {default}
28+
- **configurable as**: subfield, reference_stress
2329
* `shear_modulus`: Shear modulus subfield.
2430
- **current value**: 'subfield', from {default}
2531
- **configurable as**: subfield, shear_modulus

‎docs/user/components/materials/DerivedSubfieldsPoroelasticity.md‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
# DerivedSubfieldsPoroelasticity
2+
3+
% WARNING: Do not edit; this is a generated file!
4+
:Full name: `pylith.materials.DerivedSubfieldsPoroelasticity`
5+
:Journal name: `derivedsubfieldsporoelasticity`
6+
7+
Derived subfields associated with the poroelasticity equation.
8+
9+
For poroelastic materials these derived subfields are available for output in addition to the solution and auxiliary subfields.
10+
11+
## Pyre Facilities
12+
13+
* `bulk_density`: bulk density subfield.
14+
- **current value**: 'subfield', from {default}
15+
- **configurable as**: subfield, bulk_density
16+
* `cauchy_strain`: Cauchy strain subfield.
17+
- **current value**: 'subfield', from {default}
18+
- **configurable as**: subfield, cauchy_strain
19+
* `cauchy_stress`: Cauchy stress subfield.
20+
- **current value**: 'subfield', from {default}
21+
- **configurable as**: subfield, cauchy_stress
22+
* `water_content`: water content subfield
23+
- **current value**: 'subfield', from {default}
24+
- **configurable as**: subfield, water_content
25+
26+
## Example
27+
28+
Example of setting `DerivedSubfieldsPoroelasticity` Pyre properties and facilities in a parameter file.
29+
30+
:::{code-block} cfg
31+
# The basis order for stress and strain should be at least 1 less than the basis order for displacement.
32+
[pylithapp.problem.materials.mat_elastic.derived_subfields]
33+
cauchy_stress.basis_order = 0
34+
cauchy_strain.basis_order = 0
35+
bulk_density.basis_order = 1
36+
water_content.basis_order = 1
37+
:::
38+

‎docs/user/components/materials/index.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@ AuxSubfieldsIsotropicLinearPoroelasticity.md
1414
AuxSubfieldsIsotropicPowerLaw.md
1515
AuxSubfieldsPoroelasticity.md
1616
DerivedSubfieldsElasticity.md
17+
DerivedSubfieldsPoroelasticity.md
1718
Elasticity.md
1819
Homogeneous.md
1920
IncompressibleElasticity.md

‎docs/user/components/problems/InitialConditionPatch.md‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,11 @@
66

77
Initial conditions over a portion of the domain (patch).
88

9+
:::{warning}
10+
Initial conditions over a patch currently only work for Gmsh input files.
11+
Exodus II files from Cubit do not contain the information needed by the current PyLith implementation.
12+
:::
13+
914
Implements `InitialCondition`.
1015

1116
## Pyre Facilities

‎docs/user/components/problems/SolnDispLagrange.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,9 @@ Container for solution subfields with displacement and fault Lagrange multiplier
1111
* `displacement`: Displacement subfield.
1212
- **current value**: 'subfielddisplacement', from {default}
1313
- **configurable as**: subfielddisplacement, displacement
14-
* `lagrange_fault`: Fault Lagrange multiplier subfield.
14+
* `lagrange_multiplier_fault`: Fault Lagrange multiplier subfield.
1515
- **current value**: 'subfieldlagrangefault', from {default}
16-
- **configurable as**: subfieldlagrangefault, lagrange_fault
16+
- **configurable as**: subfieldlagrangefault, lagrange_multiplier_fault
1717

1818
## Example
1919

‎docs/user/components/problems/SolnDispPresLagrange.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,9 @@ Container for solution subfields with displacement, pressure, and fault Lagrange
1111
* `displacement`: Displacement subfield.
1212
- **current value**: 'subfielddisplacement', from {default}
1313
- **configurable as**: subfielddisplacement, displacement
14-
* `lagrange_fault`: Fault Lagrange multiplier subfield.
14+
* `lagrange_multiplier_fault`: Fault Lagrange multiplier subfield.
1515
- **current value**: 'subfieldlagrangefault', from {default}
16-
- **configurable as**: subfieldlagrangefault, lagrange_fault
16+
- **configurable as**: subfieldlagrangefault, lagrange_multiplier_fault
1717
* `pressure`: Pressure subfield.
1818
- **current value**: 'subfieldpressure', from {default}
1919
- **configurable as**: subfieldpressure, pressure

‎docs/user/components/problems/SolnDispPresTracStrainLagrange.md‎

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
# SolnDispPresTracStrainLagrange
2+
3+
% WARNING: Do not edit; this is a generated file!
4+
:Full name: `pylith.problems.SolnDispPresTracStrainLagrange`
5+
:Journal name: `SolnDispPresTracStrainLagrange`
6+
7+
Container for solution subfields with displacement, pore pressure, trace strain subfields, and fault Lagrange multiplier subfields.
8+
9+
## Pyre Facilities
10+
11+
* `displacement`: Displacement subfield.
12+
- **current value**: 'subfielddisplacement', from {default}
13+
- **configurable as**: subfielddisplacement, displacement
14+
* `lagrange_multiplier_fault`: Fault Lagrange multiplier subfield.
15+
- **current value**: 'subfieldlagrangefault', from {default}
16+
- **configurable as**: subfieldlagrangefault, lagrange_multiplier_fault
17+
* `pressure`: Pressure subfield.
18+
- **current value**: 'subfieldpressure', from {default}
19+
- **configurable as**: subfieldpressure, pressure
20+
* `trace_strain`: Trace strain subfield.
21+
- **current value**: 'subfieldtracestrain', from {default}
22+
- **configurable as**: subfieldtracestrain, trace_strain
23+
24+
## Example
25+
26+
Example of setting `SolnDispPresTracStrainLagrange` Pyre properties and facilities in a parameter file.
27+
28+
:::{code-block} cfg
29+
[pylithapp.problem]
30+
solution = pylith.problems.SolnDispPresTracStrainLagrange
31+
:::
32+

‎docs/user/components/problems/SolnDispPresTracStrainVelPdotTdotLagrange.md‎

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
# SolnDispPresTracStrainVelPdotTdotLagrange
2+
3+
% WARNING: Do not edit; this is a generated file!
4+
:Full name: `pylith.problems.SolnDispPresTracStrainVelPdotTdotLagrange`
5+
:Journal name: `solndispprestracstrainvelpdottdotlagrange`
6+
7+
Python solution field with displacement, pressure, and trace strain subfields, along with their time derivatives, and a lagrange fault.
8+
9+
## Pyre Facilities
10+
11+
* `displacement`: Displacement subfield.
12+
- **current value**: 'subfielddisplacement', from {default}
13+
- **configurable as**: subfielddisplacement, displacement
14+
* `lagrange_multiplier_fault`: Fault Lagrange multiplier subfield.
15+
- **current value**: 'subfieldlagrangefault', from {default}
16+
- **configurable as**: subfieldlagrangefault, lagrange_multiplier_fault
17+
* `pressure`: Pressure subfield.
18+
- **current value**: 'subfieldpressure', from {default}
19+
- **configurable as**: subfieldpressure, pressure
20+
* `pressure_t`: PressureT subfield.
21+
- **current value**: 'subfieldpressure_t', from {default}
22+
- **configurable as**: subfieldpressure_t, pressure_t
23+
* `trace_strain`: Trace strain subfield.
24+
- **current value**: 'subfieldtracestrain', from {default}
25+
- **configurable as**: subfieldtracestrain, trace_strain
26+
* `trace_strain_t`: TraceStrainT subfield.
27+
- **current value**: 'subfieldtracestrain_t', from {default}
28+
- **configurable as**: subfieldtracestrain_t, trace_strain_t
29+
* `velocity`: Velocity subfield.
30+
- **current value**: 'subfieldvelocity', from {default}
31+
- **configurable as**: subfieldvelocity, velocity
32+
33+
## Example
34+
35+
Example of setting `SolnDispPresTracStrainVelPdotTdotLagrange` Pyre properties and facilities in a parameter file.
36+
37+
:::{code-block} cfg
38+
[pylithapp.problem]
39+
solution = pylith.problems.SolnDispPresTracStrainVelPdotTdotLagrange
40+
:::
41+

‎docs/user/components/problems/SolnDispVelLagrange.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,9 @@ Container for solution subfields with displacement, velocity, and fault Lagrange
1111
* `displacement`: Displacement subfield.
1212
- **current value**: 'subfielddisplacement', from {default}
1313
- **configurable as**: subfielddisplacement, displacement
14-
* `lagrange_fault`: Fault Lagrange multiplier subfield.
14+
* `lagrange_multiplier_fault`: Fault Lagrange multiplier subfield.
1515
- **current value**: 'subfieldlagrangefault', from {default}
16-
- **configurable as**: subfieldlagrangefault, lagrange_fault
16+
- **configurable as**: subfieldlagrangefault, lagrange_multiplier_fault
1717
* `velocity`: Velocity subfield.
1818
- **current value**: 'subfieldvelocity', from {default}
1919
- **configurable as**: subfieldvelocity, velocity

0 commit comments

Comments
 (0)