Skip to content

Commit 2f1b1d1

Browse files
authored
Clarify documentation on setEBDirchlet() and fix link to AMReX-Hydro (#3652)
## Summary ## Additional background ## Checklist The proposed changes: - [ ] fix a bug or incorrect behavior in AMReX - [ ] add new capabilities to AMReX - [ ] changes answers in the test suite to more than roundoff level - [ ] are likely to significantly affect the results of downstream AMReX users - [ ] include documentation in the code and/or rst files, if appropriate
1 parent 72c333d commit 2f1b1d1

File tree

2 files changed

+7
-4
lines changed

2 files changed

+7
-4
lines changed

Docs/sphinx_documentation/source/LinearSolvers.rst

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -483,7 +483,9 @@ To set homogeneous Dirichlet boundary conditions, call
483483
ml_ebabeclap->setEBHomogDirichlet(lev, coeff);
484484

485485
where coeff can be a real number (i.e. the value is the same at every cell)
486-
or is the MultiFab holding the coefficient of the gradient at each cell with an EB face.
486+
or a MultiFab holding the coefficient of the gradient at each cell with an EB face.
487+
In other words, coeff is :math:`\beta` in the canonical form given in equation :eq:`eqn::abeclap`
488+
located at the EB surface centroid.
487489

488490
To set inhomogeneous Dirichlet boundary conditions, call
489491

@@ -494,8 +496,9 @@ To set inhomogeneous Dirichlet boundary conditions, call
494496
ml_ebabeclap->setEBDirichlet(lev, phi_on_eb, coeff);
495497

496498
where phi_on_eb is the MultiFab holding the Dirichlet values in every cut cell,
497-
and coeff again is a real number (i.e. the value is the same at every cell)
498-
or a MultiFab holding the coefficient of the gradient at each cell with an EB face.
499+
and coeff again is a real number
500+
or a MultiFab holding the coefficient of the gradient at each cell with an EB face,
501+
i.e. :math:`\beta` in equation :eq:`eqn::abeclap` located at the EB surface centroid.
499502

500503
Currently there are options to define the face-based coefficients on
501504
face centers vs face centroids, and to interpret the solution variable

Docs/sphinx_documentation/source/conf.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ def get_amrex_version():
4242

4343
intersphinx_mapping = {
4444
'amrex_tutorials': ('https://amrex-codes.github.io/amrex/tutorials_html/', None),
45-
'amrex_hydro':('https://amrex-codes.github.io/amrex/hydro_html/', None)
45+
'amrex_hydro':('https://amrex-fluids.github.io/amrex-hydro/docs_html/', None)
4646
}
4747

4848
# Add any paths that contain templates here, relative to this directory.

0 commit comments

Comments
 (0)