-
Notifications
You must be signed in to change notification settings - Fork 1.1k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Document heat transfer kernels. #29646
Conversation
Job Precheck, step Clang format on 5a012b4 wanted to post the following: Your code requires style changes. A patch was auto generated and copied here
Alternatively, with your repository up to date and in the top level of your repository:
|
Job Documentation, step Docs: sync website on 332ed8f wanted to post the following: View the site here This comment will be updated on new commits. |
Job Coverage, step Generate coverage on 332ed8f wanted to post the following: Framework coverageCoverage did not change Modules coverageHeat transfer
Full coverage reportsReports
This comment will be updated on new commits. |
I think the test failure is unrelated? |
framework/doc/content/source/materials/ADGenericConstantMaterial.md
Outdated
Show resolved
Hide resolved
modules/heat_transfer/doc/content/source/bcs/ConvectiveHeatFluxBC.md
Outdated
Show resolved
Hide resolved
modules/heat_transfer/doc/content/source/kernels/ADHeatConduction.md
Outdated
Show resolved
Hide resolved
modules/heat_transfer/doc/content/source/kernels/ADHeatConductionTimeDerivative.md
Outdated
Show resolved
Hide resolved
modules/heat_transfer/doc/content/source/kernels/ADHeatConductionTimeDerivative.md
Outdated
Show resolved
Hide resolved
modules/heat_transfer/doc/content/source/kernels/AnisoHeatConduction.md
Outdated
Show resolved
Hide resolved
modules/heat_transfer/doc/content/source/kernels/HeatConductionTimeDerivative.md
Outdated
Show resolved
Hide resolved
Co-authored-by: Alex Lindsay <[email protected]>
I opted to remove any discussion about Jacobians -- it's not done uniformly across the documentation, and IMO if someone is concerned about Jacobian issues they should be using AD. Other than the comment about AD vs. non-AD markdown files, I think I've addressed everything. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
woops I led you astray there for a bit
modules/heat_transfer/doc/content/source/kernels/AnisoHeatConduction.md
Outdated
Show resolved
Hide resolved
modules/heat_transfer/doc/content/source/kernels/HeatConduction.md
Outdated
Show resolved
Hide resolved
modules/heat_transfer/doc/content/source/kernels/HeatConduction.md
Outdated
Show resolved
Hide resolved
modules/heat_transfer/doc/content/source/kernels/HeatConductionTimeDerivative.md
Outdated
Show resolved
Hide resolved
modules/heat_transfer/doc/content/source/kernels/HeatConductionTimeDerivative.md
Outdated
Show resolved
Hide resolved
modules/heat_transfer/doc/content/source/kernels/HeatConductionTimeDerivative.md
Outdated
Show resolved
Hide resolved
Co-authored-by: Alex Lindsay <[email protected]>
2f9780c
to
f70a51c
Compare
Looks like you still have some links to |
ack sorry, fixed it. |
failure unrelated to documentation |
Closes #29645
Reason
I would like to teach a class using MOOSE; improved documentation will help students.
Summary/Justification of Changes
Discussion for additional ideas not yet in this PR:
HeatCapacityConductionTimeDerivative
. Looks like it's not used anywhere in the framework, not even tested.SpecificHeatConductionTimeDerivative
looks like a better version ofHeatConductionTimeDerivative
because it uses theDerivativeMaterialInterface
to get off-diagonal Jacobian terms. Would suggest makingHeatConductionTimeDerivative
internally equivalent to the former and then deprecatingSpecificHeatConductionTimeDerivative
to remove confusion.