Skip to content

Add Tracer Documentation#2017

Open
brunaccampos wants to merge 13 commits into
masterfrom
add_tracer_documentation
Open

Add Tracer Documentation#2017
brunaccampos wants to merge 13 commits into
masterfrom
add_tracer_documentation

Conversation

@brunaccampos

@brunaccampos brunaccampos commented Jun 9, 2026

Copy link
Copy Markdown
Collaborator

Description

This PR adds the passive tracer documentation. Also, the tracer concentration variable in the code was changed from T to C so that it is distinct from the temperature variable.

Miscellaneous (will be removed when merged)

The class CouplingEvaluationSIPG in the mortar feature was renamed to ScalarCouplingEvaluation to improve its description. This is the class that will be used to couple the mortar and tracer features, which will be done in a future PR.

Checklist (will be removed when merged)

See this page for more information about the pull request process.

Code related list:

  • All in-code documentation related to this PR is up to date (Doxygen format)
  • Copyright headers are present and up to date
  • The branch is rebased onto master
  • Code is indented with indent-all and .prm files (examples and tests) with prm-indent

Pull request related list:

  • Labels are applied
  • There are at least 2 reviewers (or 1 if small feature)
  • If any future work is planned, an issue is opened
  • The PR description is clean and is ready to be used as the commit message when merging the PR

@brunaccampos brunaccampos added Documentation Ready for review PR is ready to be reviewed labels Jun 9, 2026
@brunaccampos brunaccampos requested a review from oguevremont June 10, 2026 13:44

@oguevremont oguevremont left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Excellent addition! it will be nice to have in the theory guide
I only had minor suggestions and comments, but other than that it looks good to me

Comment thread doc/source/theory/multiphysics/passive_tracer/passive_tracer_equations.rst Outdated
Comment thread doc/source/theory/multiphysics/passive_tracer/passive_tracer_equations.rst Outdated
Comment thread doc/source/theory/multiphysics/passive_tracer/passive_tracer_equations.rst Outdated
Comment thread doc/source/theory/multiphysics/passive_tracer/passive_tracer_equations.rst Outdated
Comment thread include/solvers/tracer.h Outdated

@blaisb blaisb left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some small comments and small improvements. nothing major

Comment thread doc/source/theory/multiphysics/passive_tracer/passive_tracer_equations.rst Outdated
Comment thread doc/source/theory/multiphysics/passive_tracer/passive_tracer_equations.rst Outdated
Comment thread doc/source/theory/multiphysics/passive_tracer/passive_tracer_equations.rst Outdated
Comment thread doc/source/theory/multiphysics/passive_tracer/passive_tracer_equations.rst Outdated
Comment thread include/core/mortar_coupling_manager.h Outdated
Comment thread source/solvers/tracer_assemblers.cc Outdated
Comment thread source/solvers/tracer_assemblers.cc Outdated
Comment thread source/solvers/tracer_assemblers.cc Outdated
Comment thread source/solvers/tracer_assemblers.cc Outdated
Comment thread source/solvers/tracer_assemblers.cc Outdated
@blaisb blaisb added Reviewed and waiting for changes and removed Ready for review PR is ready to be reviewed labels Jun 11, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants