Skip to content

Commit

Permalink
Clarify documentation on setEBDirchlet()
Browse files Browse the repository at this point in the history
  • Loading branch information
cgilet committed Dec 1, 2023
1 parent 2f47fa7 commit 264c090
Showing 1 changed file with 6 additions and 3 deletions.
9 changes: 6 additions & 3 deletions Docs/sphinx_documentation/source/LinearSolvers.rst
Original file line number Diff line number Diff line change
Expand Up @@ -483,7 +483,9 @@ To set homogeneous Dirichlet boundary conditions, call
ml_ebabeclap->setEBHomogDirichlet(lev, coeff);

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

To set inhomogeneous Dirichlet boundary conditions, call

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

where phi_on_eb is the MultiFab holding the Dirichlet values in every cut cell,
and coeff again is a real number (i.e. the value is the same at every cell)
or a MultiFab holding the coefficient of the gradient at each cell with an EB face.
and coeff again is a real number
or a MultiFab holding the coefficient of the gradient at each cell with an EB face,
i.e. :math:`/beta` in equation :ref:`eqn::abeclap` located at the EB surface centroid.

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

0 comments on commit 264c090

Please sign in to comment.