Skip to content
Snippets Groups Projects
Commit a0e4cdbe authored by David Seus's avatar David Seus
Browse files

update documentation of DomainPatch class. Fix setting has_interface

parent 3ccc82f2
No related branches found
No related tags found
No related merge requests found
......@@ -33,22 +33,8 @@ class DomainPatch(df.SubDomain):
The constructor accepts
# Parameters
outerBoundaryParts #type tp.List[tp.List[df.Point]]: contains a list of
boundary parts of the subdomain which are also outer
parts of the boundary. These boundary parts in turn
are lists of dolfin points representing the 1D poly-
gone that the boundary part in comprised of.
interfaces #type tp.List[tp.List[df.Point]]: contains a list of
boundary parts of the subdomain which are interfaces
to neighboring subdomains. These interfaces in turn
are lists of dolfin points representing the 1D poly-
gone that the interface in comprised of. The ordering
of the interfaces should be as follows: the interface
interface[i] should correspond to the neighbour given
by neighbour[i].
neighbours #type tp.List[int]
isRichards #type: bool return true if Richards model is
assumed on patch.
mesh #type df::Mesh & Dolfin mesh object, submesh of the
subdomain.
......@@ -57,29 +43,34 @@ class DomainPatch(df.SubDomain):
assumed to be constant in space.
viscosity #type tp.List[float] viscosity(ies) of the the
fluid phases in the patch viscosity[1] is assumed
fluid phases in the patch viscosity[0] is assumed
to be the viscosity of the wetting phase and if
present (is_Richards() = True, length(viscosity) == 2)
viscosity[2] is assumed to be the viscosity of the non-
wetting phase.
present (isRichards == False) viscosity[1] is
assumed to be the viscosity of the non-wetting phase.
has_interface #type tp.List[int]: list of indices (w.r.t. the global
numbering of interfaces in
LDDsimulation.interfaces) indicating
which interfaces are part of the
subdomain.
relative_permeability #type tp.List[df.Expression] list containing the relative
permeabilities. relative_permeability[1] is assumed
to be the relative permeability of the wetting phase and if
present (is_Richards() = True, length(relative_permeability) == 2)
relative_permeability[2] is assumed to be the relative
permeability of the non-wetting phase.
L #type tp.List[float] L parameters for the L-scheme. In
case isRichards == False (i.e
two-phase flow is assumed on the
patch) we have two parameters, one
for each equation.
lambda_param #tp.List[float] L parameters for the L-scheme. In
case isRichards == False (i.e
two-phase flow is assumed on the
patch) we have two parameters, one
for each equation.
tol #type float, the calculation tolerance of the class
## Public Variables
## Public Methods
is_Richards(self) -> bool #return type bool return true if Richards model is
assumed on patch.
"""
# default class variable values
......@@ -91,6 +82,7 @@ class DomainPatch(df.SubDomain):
mesh: df.Mesh,#
porosity: float,#
viscosity: tp.List[float],#
has_interface: tp.List[int],#
L: tp.List[float],#
lambda_param: tp.List[float],#
):
......@@ -104,6 +96,7 @@ class DomainPatch(df.SubDomain):
self.mesh = mesh
self.porosity = porosity
self.viscosity = viscosity
self.has_interface = has_interface
self.L = L
self.lambda_param = lambda_param
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment