Updated docs

docs/src/index.md

@@ -68,7 +68,7 @@ In FerriteInterfaceElements, their implementation is based on the idea to combin
 two embedded elements to represent the to sides of an interface. At the current state,
 it is only supported to use the same interpolation on both sides. To distinguish
 the two sides, they are referred to as *here* and *there*. The jump of a
-field is then defined as from *here* to *there*: *field there - field here*.
+field is then defined as *field here - field there*.
 
 Another key definition is the reference shape of interface elements. In
 FerriteInterfaceElements, the shape is chosen to be of the same dimension as the

docs/src/literate-tutorials/heat_equation.jl

@@ -29,10 +29,7 @@
 # in temperature from the particle to the matrix domain. For simplicity we set $k_{if} = 1$.
 #
 # Note that the two sides of an interface are referred to as "here" and "there".
-# The provided functions use a jump as defined from "here" to "there".
-# So, in this example the particles are to be considered the side "here".
-# (Here, this is not really relevant, since the sign of the jump has no influence
-# on the result in the weak form. In general, this could be relevant.)
+# The provided functions use a jump defined as "there - here".
 #
 # The resulting weak form is given given as follows: Find ``u \in \mathbb{U}`` such that
 # ```math

src/cellvalues.jl

@@ -174,6 +174,7 @@ end
 
 Return the value of shape function `i` evaluated in quadrature point `qp`
 for computing the value jump on an interface.
+The jump is defined as "here - there".
 """
 function Ferrite.shape_value_jump(cv::InterfaceCellValues, qp::Int, i::Int)
     side, baseindex = cv.sides_and_baseindices[i]
@@ -185,6 +186,7 @@ end
 
 Return the gradient of shape function `i` evaluated in quadrature point `qp`
 for computing the gradient jump on an interface.
+The jump is defined as "here - there".
 """
 function Ferrite.shape_gradient_jump(cv::InterfaceCellValues, qp::Int, i::Int)
     side, baseindex = cv.sides_and_baseindices[i]
@@ -263,6 +265,7 @@ end
     function_value_jump(cv::InterfaceCellValues, qp::Int, u::AbstractVector)
 
 Compute the jump of the function value in a quadrature point.
+The jump is defined as "here - there".
 """
 function Ferrite.function_value_jump(cv::InterfaceCellValues, qp::Int, u::AbstractVector)
     return function_value(cv, qp, u; here=true) - function_value(cv, qp, u; here=false)
@@ -272,6 +275,7 @@ end
     function_gradient_jump(cv::InterfaceCellValues, qp::Int, u::AbstractVector)
 
 Compute the jump of the function gradient in a quadrature point.
+The jump is defined as "here - there".
 """
 function Ferrite.function_gradient_jump(cv::InterfaceCellValues, qp::Int, u::AbstractVector)
     return function_gradient(cv, qp, u; here=true) - function_gradient(cv, qp, u; here=false)