Skip to content

Commit ecbbbcc

Browse files
committed
Address Josh review
- fix documentation
1 parent b834588 commit ecbbbcc

File tree

3 files changed

+7
-1
lines changed

3 files changed

+7
-1
lines changed

framework/doc/content/source/physics/DiffusionCG.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,24 +8,28 @@ See the [DiffusionPhysicsBase.md] documentation for the diffusion equation solve
88

99
The volumetric discretization of the time derivative uses the [TimeDerivative.md] kernel.
1010
The diffusion term $\nabla \cdot D \nabla u(\vec{x})$ is integrated by parts and represented using:
11+
1112
- a [Diffusion.md] kernel if no diffusion coefficient is passed
1213
- a [MatDiffusion.md] kernel if a diffusion coefficient is passed, usually as a [material property](syntax/Materials/index.md)
1314

1415

1516
The source term $f$ is added using:
17+
1618
- a [BodyForce.md] if the source is a constant, a [Postprocessor](syntax/Postprocessors/index.md) or a [Function](syntax/Functions/index.md)
1719
- a [MatCoupledForce.md] if the force is specified using a material property
1820
- a [CoupledForce.md] if the source is another type of [functor](syntax/Functors/index.md)
1921

2022

2123
The Dirichlet boundary conditions are created using:
24+
2225
- a [DirichletBC.md] if the boundary value is set to a number
2326
- a [FunctionDirichletBC.md] if set to a [Function](syntax/Functions/index.md)
2427
- a [PostprocessorDirichletBC.md] if set to a [Postprocessor](syntax/Postprocessors/index.md)
2528
- a [FunctorDirichletBC.md] for any other kind of [functor](syntax/Functors/index.md) for the boundary value
2629

2730

2831
The Neumann boundary conditions are created using:
32+
2933
- a [NeumannBC.md] if the flux is set to a number
3034
- a [FunctionNeumannBC.md] if set to a [Function](syntax/Functions/index.md)
3135
- a [PostprocessorNeumannBC.md] if set to a [Postprocessor](syntax/Postprocessors/index.md)

framework/doc/content/source/physics/DiffusionFV.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,12 +15,14 @@ The source term $f$ is added using:
1515

1616

1717
The Dirichlet boundary conditions are created using:
18+
1819
- a [FVDirichletBC.md] if the boundary value is set to a number
1920
- a [FVFunctionDirichletBC.md] if set to a [Function](syntax/Functions/index.md)
2021
- a [FVFunctorDirichletBC.md] for any other kind of [functor](syntax/Functors/index.md) for the boundary value
2122

2223

2324
The Neumann boundary conditions are created using:
25+
2426
- a [FVNeumannBC.md] if the flux is set to a number
2527
- a [FVFunctionNeumannBC.md] if set to a [Function](syntax/Functions/index.md)
2628
- a [FVFunctorNeumannBC.md] for any other kind of [functor](syntax/Functors/index.md) for the flux value

modules/heat_transfer/doc/content/source/physics/HeatConductionFE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Heat Conduction Finite Element
1+
# HeatConductionFE
22

33
This [Physics](syntax/Physics/index.md) object implements the heat conduction equation over a
44
volumetric domain using a continuous Galerkin finite element discretization.

0 commit comments

Comments
 (0)