Skip to content

Commit

Permalink
deploy: a7a92fe
Browse files Browse the repository at this point in the history
  • Loading branch information
@lmoresi
lmoresi committed Sep 27, 2024
1 parent a1aca12 commit 1de64f3
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 10 deletions.
2 changes: 1 addition & 1 deletion Quick_Start_Docs_api/underworld3/swarm.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -290,7 +290,7 @@ <h3>Inherited members</h3>
</dd>
<dt id="underworld3.swarm.NodalPointSwarm"><code class="flex name class">
<span>class <span class="ident">NodalPointSwarm</span></span>
<span>(</span><span>trackedVariable: <function MeshVariable at 0x7fcea6afdfc0>, verbose=False)</span>
<span>(</span><span>trackedVariable: <function MeshVariable at 0x7ffb4fe89fc0>, verbose=False)</span>
</code></dt>
<dd>
<div class="desc"><p>Swarm with particles located at the coordinate points of a meshVariable</p>
Expand Down
18 changes: 9 additions & 9 deletions Quick_Start_Docs_api/underworld3/systems/solvers.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ <h2 class="section-title" id="header-classes">Classes</h2>
<dl>
<dt id="underworld3.systems.solvers.SNES_AdvectionDiffusion"><code class="flex name class">
<span>class <span class="ident">SNES_AdvectionDiffusion</span></span>
<span>(</span><span>mesh: <a title="underworld3.discretisation.Mesh" href="../discretisation.html#underworld3.discretisation.Mesh">Mesh</a>, u_Field: <function MeshVariable at 0x7fcea6afdfc0>, V_fn: Union[MeshVariable, sympy.core.basic.Basic], order: int = 1, solver_name: str = '', restore_points_func: Callable = None, verbose=False, DuDt: Union[<a title="underworld3.systems.ddt.SemiLagrangian" href="ddt.html#underworld3.systems.ddt.SemiLagrangian">SemiLagrangian</a>, <a title="underworld3.systems.ddt.Lagrangian" href="ddt.html#underworld3.systems.ddt.Lagrangian">Lagrangian</a>] = None, DFDt: Union[<a title="underworld3.systems.ddt.SemiLagrangian" href="ddt.html#underworld3.systems.ddt.SemiLagrangian">SemiLagrangian</a>, <a title="underworld3.systems.ddt.Lagrangian" href="ddt.html#underworld3.systems.ddt.Lagrangian">Lagrangian</a>] = None)</span>
<span>(</span><span>mesh: <a title="underworld3.discretisation.Mesh" href="../discretisation.html#underworld3.discretisation.Mesh">Mesh</a>, u_Field: <function MeshVariable at 0x7ffb4fe89fc0>, V_fn: Union[MeshVariable, sympy.core.basic.Basic], order: int = 1, solver_name: str = '', restore_points_func: Callable = None, verbose=False, DuDt: Union[<a title="underworld3.systems.ddt.SemiLagrangian" href="ddt.html#underworld3.systems.ddt.SemiLagrangian">SemiLagrangian</a>, <a title="underworld3.systems.ddt.Lagrangian" href="ddt.html#underworld3.systems.ddt.Lagrangian">Lagrangian</a>] = None, DFDt: Union[<a title="underworld3.systems.ddt.SemiLagrangian" href="ddt.html#underworld3.systems.ddt.SemiLagrangian">SemiLagrangian</a>, <a title="underworld3.systems.ddt.Lagrangian" href="ddt.html#underworld3.systems.ddt.Lagrangian">Lagrangian</a>] = None)</span>
</code></dt>
<dd>
<div class="desc"><p>This class provides a solver for the scalar Advection-Diffusion equation using the characteristics based Semi-Lagrange Crank-Nicholson method
Expand Down Expand Up @@ -534,7 +534,7 @@ <h2 id="params">Params</h2>
</dd>
<dt id="underworld3.systems.solvers.SNES_Darcy"><code class="flex name class">
<span>class <span class="ident">SNES_Darcy</span></span>
<span>(</span><span>mesh: <a title="underworld3.discretisation.Mesh" href="../discretisation.html#underworld3.discretisation.Mesh">Mesh</a>, h_Field: Optional[<function MeshVariable at 0x7fcea6afdfc0>] = None, v_Field: Optional[<function MeshVariable at 0x7fcea6afdfc0>] = None, degree: int = 2, solver_name: str = '', verbose=False, DuDt=None, DFDt=None)</span>
<span>(</span><span>mesh: <a title="underworld3.discretisation.Mesh" href="../discretisation.html#underworld3.discretisation.Mesh">Mesh</a>, h_Field: Optional[<function MeshVariable at 0x7ffb4fe89fc0>] = None, v_Field: Optional[<function MeshVariable at 0x7ffb4fe89fc0>] = None, degree: int = 2, solver_name: str = '', verbose=False, DuDt=None, DFDt=None)</span>
</code></dt>
<dd>
<div class="desc"><p>This class provides functionality for a discrete representation
Expand Down Expand Up @@ -907,7 +907,7 @@ <h2 id="params">Params</h2>
</dd>
<dt id="underworld3.systems.solvers.SNES_NavierStokes"><code class="flex name class">
<span>class <span class="ident">SNES_NavierStokes</span></span>
<span>(</span><span>mesh: <a title="underworld3.discretisation.Mesh" href="../discretisation.html#underworld3.discretisation.Mesh">Mesh</a>, velocityField: <function MeshVariable at 0x7fcea6afdfc0>, pressureField: <function MeshVariable at 0x7fcea6afdfc0>, rho: Optional[float] = 0.0, restore_points_func: Callable = None, order: Optional[int] = 2, p_continuous: Optional[bool] = False, solver_name: Optional[str] = '', verbose: Optional[bool] = False, DuDt: Union[<a title="underworld3.systems.ddt.SemiLagrangian" href="ddt.html#underworld3.systems.ddt.SemiLagrangian">SemiLagrangian</a>, <a title="underworld3.systems.ddt.Lagrangian" href="ddt.html#underworld3.systems.ddt.Lagrangian">Lagrangian</a>] = None, DFDt: Union[<a title="underworld3.systems.ddt.SemiLagrangian" href="ddt.html#underworld3.systems.ddt.SemiLagrangian">SemiLagrangian</a>, <a title="underworld3.systems.ddt.Lagrangian" href="ddt.html#underworld3.systems.ddt.Lagrangian">Lagrangian</a>] = None)</span>
<span>(</span><span>mesh: <a title="underworld3.discretisation.Mesh" href="../discretisation.html#underworld3.discretisation.Mesh">Mesh</a>, velocityField: <function MeshVariable at 0x7ffb4fe89fc0>, pressureField: <function MeshVariable at 0x7ffb4fe89fc0>, rho: Optional[float] = 0.0, restore_points_func: Callable = None, order: Optional[int] = 2, p_continuous: Optional[bool] = False, solver_name: Optional[str] = '', verbose: Optional[bool] = False, DuDt: Union[<a title="underworld3.systems.ddt.SemiLagrangian" href="ddt.html#underworld3.systems.ddt.SemiLagrangian">SemiLagrangian</a>, <a title="underworld3.systems.ddt.Lagrangian" href="ddt.html#underworld3.systems.ddt.Lagrangian">Lagrangian</a>] = None, DFDt: Union[<a title="underworld3.systems.ddt.SemiLagrangian" href="ddt.html#underworld3.systems.ddt.SemiLagrangian">SemiLagrangian</a>, <a title="underworld3.systems.ddt.Lagrangian" href="ddt.html#underworld3.systems.ddt.Lagrangian">Lagrangian</a>] = None)</span>
</code></dt>
<dd>
<div class="desc"><p>This class provides a solver for the Navier-Stokes (vector Advection-Diffusion) equation which is similar to that
Expand Down Expand Up @@ -1701,7 +1701,7 @@ <h2 id="params">Params</h2>
</dd>
<dt id="underworld3.systems.solvers.SNES_Poisson"><code class="flex name class">
<span>class <span class="ident">SNES_Poisson</span></span>
<span>(</span><span>mesh: <a title="underworld3.discretisation.Mesh" href="../discretisation.html#underworld3.discretisation.Mesh">Mesh</a>, u_Field: <function MeshVariable at 0x7fcea6afdfc0> = None, solver_name: str = '', verbose=False, degree=2, DuDt: Union[<a title="underworld3.systems.ddt.SemiLagrangian" href="ddt.html#underworld3.systems.ddt.SemiLagrangian">SemiLagrangian</a>, <a title="underworld3.systems.ddt.Lagrangian" href="ddt.html#underworld3.systems.ddt.Lagrangian">Lagrangian</a>] = None, DFDt: Union[<a title="underworld3.systems.ddt.SemiLagrangian" href="ddt.html#underworld3.systems.ddt.SemiLagrangian">SemiLagrangian</a>, <a title="underworld3.systems.ddt.Lagrangian" href="ddt.html#underworld3.systems.ddt.Lagrangian">Lagrangian</a>] = None)</span>
<span>(</span><span>mesh: <a title="underworld3.discretisation.Mesh" href="../discretisation.html#underworld3.discretisation.Mesh">Mesh</a>, u_Field: <function MeshVariable at 0x7ffb4fe89fc0> = None, solver_name: str = '', verbose=False, degree=2, DuDt: Union[<a title="underworld3.systems.ddt.SemiLagrangian" href="ddt.html#underworld3.systems.ddt.SemiLagrangian">SemiLagrangian</a>, <a title="underworld3.systems.ddt.Lagrangian" href="ddt.html#underworld3.systems.ddt.Lagrangian">Lagrangian</a>] = None, DFDt: Union[<a title="underworld3.systems.ddt.SemiLagrangian" href="ddt.html#underworld3.systems.ddt.SemiLagrangian">SemiLagrangian</a>, <a title="underworld3.systems.ddt.Lagrangian" href="ddt.html#underworld3.systems.ddt.Lagrangian">Lagrangian</a>] = None)</span>
</code></dt>
<dd>
<div class="desc"><p>This class provides functionality for a discrete representation
Expand Down Expand Up @@ -1933,7 +1933,7 @@ <h3>Methods</h3>
</dd>
<dt id="underworld3.systems.solvers.SNES_Projection"><code class="flex name class">
<span>class <span class="ident">SNES_Projection</span></span>
<span>(</span><span>mesh: <a title="underworld3.discretisation.Mesh" href="../discretisation.html#underworld3.discretisation.Mesh">Mesh</a>, u_Field: <function MeshVariable at 0x7fcea6afdfc0> = None, degree=2, solver_name: str = '', verbose=False)</span>
<span>(</span><span>mesh: <a title="underworld3.discretisation.Mesh" href="../discretisation.html#underworld3.discretisation.Mesh">Mesh</a>, u_Field: <function MeshVariable at 0x7ffb4fe89fc0> = None, degree=2, solver_name: str = '', verbose=False)</span>
</code></dt>
<dd>
<div class="desc"><p>Solves $u = \tilde{f}$ where $\tilde{f}$ is a function that can be evaluated within an element and
Expand Down Expand Up @@ -2173,7 +2173,7 @@ <h3>Instance variables</h3>
</dd>
<dt id="underworld3.systems.solvers.SNES_Stokes"><code class="flex name class">
<span>class <span class="ident">SNES_Stokes</span></span>
<span>(</span><span>mesh: <a title="underworld3.discretisation.Mesh" href="../discretisation.html#underworld3.discretisation.Mesh">Mesh</a>, velocityField: Optional[<function MeshVariable at 0x7fcea6afdfc0>] = None, pressureField: Optional[<function MeshVariable at 0x7fcea6afdfc0>] = None, degree: Optional[int] = 2, p_continuous: Optional[bool] = True, solver_name: Optional[str] = '', verbose: Optional[bool] = False, DuDt: Union[<a title="underworld3.systems.ddt.SemiLagrangian" href="ddt.html#underworld3.systems.ddt.SemiLagrangian">SemiLagrangian</a>, <a title="underworld3.systems.ddt.Lagrangian" href="ddt.html#underworld3.systems.ddt.Lagrangian">Lagrangian</a>] = None, DFDt: Union[<a title="underworld3.systems.ddt.SemiLagrangian" href="ddt.html#underworld3.systems.ddt.SemiLagrangian">SemiLagrangian</a>, <a title="underworld3.systems.ddt.Lagrangian" href="ddt.html#underworld3.systems.ddt.Lagrangian">Lagrangian</a>] = None)</span>
<span>(</span><span>mesh: <a title="underworld3.discretisation.Mesh" href="../discretisation.html#underworld3.discretisation.Mesh">Mesh</a>, velocityField: Optional[<function MeshVariable at 0x7ffb4fe89fc0>] = None, pressureField: Optional[<function MeshVariable at 0x7ffb4fe89fc0>] = None, degree: Optional[int] = 2, p_continuous: Optional[bool] = True, solver_name: Optional[str] = '', verbose: Optional[bool] = False, DuDt: Union[<a title="underworld3.systems.ddt.SemiLagrangian" href="ddt.html#underworld3.systems.ddt.SemiLagrangian">SemiLagrangian</a>, <a title="underworld3.systems.ddt.Lagrangian" href="ddt.html#underworld3.systems.ddt.Lagrangian">Lagrangian</a>] = None, DFDt: Union[<a title="underworld3.systems.ddt.SemiLagrangian" href="ddt.html#underworld3.systems.ddt.SemiLagrangian">SemiLagrangian</a>, <a title="underworld3.systems.ddt.Lagrangian" href="ddt.html#underworld3.systems.ddt.Lagrangian">Lagrangian</a>] = None)</span>
</code></dt>
<dd>
<div class="desc"><p>This class provides functionality for a discrete representation
Expand Down Expand Up @@ -2767,7 +2767,7 @@ <h3>Methods</h3>
</dd>
<dt id="underworld3.systems.solvers.SNES_Tensor_Projection"><code class="flex name class">
<span>class <span class="ident">SNES_Tensor_Projection</span></span>
<span>(</span><span>mesh: <a title="underworld3.discretisation.Mesh" href="../discretisation.html#underworld3.discretisation.Mesh">Mesh</a>, tensor_Field: <function MeshVariable at 0x7fcea6afdfc0> = None, scalar_Field: <function MeshVariable at 0x7fcea6afdfc0> = None, degree=2, solver_name: str = '', verbose=False)</span>
<span>(</span><span>mesh: <a title="underworld3.discretisation.Mesh" href="../discretisation.html#underworld3.discretisation.Mesh">Mesh</a>, tensor_Field: <function MeshVariable at 0x7ffb4fe89fc0> = None, scalar_Field: <function MeshVariable at 0x7ffb4fe89fc0> = None, degree=2, solver_name: str = '', verbose=False)</span>
</code></dt>
<dd>
<div class="desc"><p>Solves $\mathbf{u} = \tilde{\mathbf{f}}$ where $\tilde{\mathbf{f}}$ is a tensor-valued function that can be evaluated within an element and
Expand Down Expand Up @@ -2994,7 +2994,7 @@ <h2 id="params">Params</h2>
</dd>
<dt id="underworld3.systems.solvers.SNES_VE_Stokes"><code class="flex name class">
<span>class <span class="ident">SNES_VE_Stokes</span></span>
<span>(</span><span>mesh: <a title="underworld3.discretisation.Mesh" href="../discretisation.html#underworld3.discretisation.Mesh">Mesh</a>, velocityField: Optional[<function MeshVariable at 0x7fcea6afdfc0>] = None, pressureField: Optional[<function MeshVariable at 0x7fcea6afdfc0>] = None, degree: Optional[int] = 2, order: Optional[int] = 2, p_continuous: Optional[bool] = True, solver_name: Optional[str] = '', verbose: Optional[bool] = False, DuDt: Union[<a title="underworld3.systems.ddt.SemiLagrangian" href="ddt.html#underworld3.systems.ddt.SemiLagrangian">SemiLagrangian</a>, <a title="underworld3.systems.ddt.Lagrangian" href="ddt.html#underworld3.systems.ddt.Lagrangian">Lagrangian</a>] = None, DFDt: Union[<a title="underworld3.systems.ddt.SemiLagrangian" href="ddt.html#underworld3.systems.ddt.SemiLagrangian">SemiLagrangian</a>, <a title="underworld3.systems.ddt.Lagrangian" href="ddt.html#underworld3.systems.ddt.Lagrangian">Lagrangian</a>] = None)</span>
<span>(</span><span>mesh: <a title="underworld3.discretisation.Mesh" href="../discretisation.html#underworld3.discretisation.Mesh">Mesh</a>, velocityField: Optional[<function MeshVariable at 0x7ffb4fe89fc0>] = None, pressureField: Optional[<function MeshVariable at 0x7ffb4fe89fc0>] = None, degree: Optional[int] = 2, order: Optional[int] = 2, p_continuous: Optional[bool] = True, solver_name: Optional[str] = '', verbose: Optional[bool] = False, DuDt: Union[<a title="underworld3.systems.ddt.SemiLagrangian" href="ddt.html#underworld3.systems.ddt.SemiLagrangian">SemiLagrangian</a>, <a title="underworld3.systems.ddt.Lagrangian" href="ddt.html#underworld3.systems.ddt.Lagrangian">Lagrangian</a>] = None, DFDt: Union[<a title="underworld3.systems.ddt.SemiLagrangian" href="ddt.html#underworld3.systems.ddt.SemiLagrangian">SemiLagrangian</a>, <a title="underworld3.systems.ddt.Lagrangian" href="ddt.html#underworld3.systems.ddt.Lagrangian">Lagrangian</a>] = None)</span>
</code></dt>
<dd>
<div class="desc"><p>This class provides functionality for a discrete representation
Expand Down Expand Up @@ -3314,7 +3314,7 @@ <h2 id="params">Params</h2>
</dd>
<dt id="underworld3.systems.solvers.SNES_Vector_Projection"><code class="flex name class">
<span>class <span class="ident">SNES_Vector_Projection</span></span>
<span>(</span><span>mesh: <a title="underworld3.discretisation.Mesh" href="../discretisation.html#underworld3.discretisation.Mesh">Mesh</a>, u_Field: <function MeshVariable at 0x7fcea6afdfc0> = None, degree=2, solver_name: str = '', verbose=False)</span>
<span>(</span><span>mesh: <a title="underworld3.discretisation.Mesh" href="../discretisation.html#underworld3.discretisation.Mesh">Mesh</a>, u_Field: <function MeshVariable at 0x7ffb4fe89fc0> = None, degree=2, solver_name: str = '', verbose=False)</span>
</code></dt>
<dd>
<div class="desc"><p>Solves $\mathbf{u} = \tilde{\mathbf{f}}$ where $\tilde{\mathbf{f}}$ is a vector function that can be evaluated within an element and
Expand Down

0 comments on commit 1de64f3

Please sign in to comment.