Lethe Open-Source Library
version 1.2.0
Developer Guide
Loading...
Searching...
No Matches
main.h
Go to the documentation of this file.
1
// SPDX-FileCopyrightText: Copyright (c) 2023-2026 The Lethe Authors
2
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception OR LGPL-2.1-or-later
3
4
/**
5
* @mainpage
6
*
7
* An outline of the main classes in Lethe and how they interact is given by the following
8
* clickable graph:
9
*
10
* @dot
11
* digraph main_classes {
12
graph [bgcolor="transparent", align=true, ranksep=1, nodesep=0.5];
13
node [fontname="FreeSans",fontsize=15,
14
shape=record,height=0.2,width=0.4,
15
color="royalblue", fillcolor="white", style="filled"];
16
edge [color="royalblue", weight=10];
17
rankdir="LR";
18
size = "16,10";
19
20
21
//---------------------------------
22
// Particles Ray Tracing
23
//---------------------------------
24
25
particles_ray_tracing_solver [label=<<B>RayTracingSolver</B> <br/>(lethe-particles-ray-tracing)>, href="https://chaos-polymtl.github.io/lethe/doxygen/classRayTracingSolver.html", tooltip="RayTracingSolver", fillcolor="#8ba5d4"];
26
27
28
//---------------------------------
29
// DEM
30
//---------------------------------
31
32
dem_solver [label=<<B>DEMSolver</B> <br/>(lethe-particles)>, href="https://chaos-polymtl.github.io/lethe/doxygen/classDEMSolver.html", tooltip="DEMSolver", fillcolor="#8ba5d4"];
33
34
35
//---------------------------------
36
// Physics Solver
37
//---------------------------------
38
39
physics_solver [label="PhysicsSolver", href="https://chaos-polymtl.github.io/lethe/doxygen/classPhysicsSolver.html"];
40
41
navier_stokes_base [label="NavierStokesBase",href="https://chaos-polymtl.github.io/lethe/doxygen/classNavierStokesBase.html"];
42
43
auxiliary_physics [label="AuxiliaryPhysics",href="https://chaos-polymtl.github.io/lethe/doxygen/classAuxiliaryPhysics.html"];
44
45
physics_solver:e -> navier_stokes_base:w [dir=back];
46
physics_solver:e -> auxiliary_physics:w [dir=back];
47
48
navier_stokes_base_1 [label=<<B>FluidDynamicsMatrixBased</B> <br/>(lethe-fluid)>,href="https://chaos-polymtl.github.io/lethe/doxygen/classFluidDynamicsMatrixBased.html", tooltip="FluidDynamicsMatrixBased", fillcolor="#8ba5d4"];
49
navier_stokes_base_2 [label=<<B>FluidDynamicsBlock</B> <br/> (lethe-fluid-block)>,href="https://chaos-polymtl.github.io/lethe/doxygen/classFluidDynamicsBlock.html", tooltip="FluidDynamicsBlock", fillcolor="#8ba5d4"];
50
navier_stokes_base_3 [label=<<B>FluidDynamicsMatrixFree</B> <br/> (lethe-fluid-matrix-free)>,href="https://chaos-polymtl.github.io/lethe/doxygen/classFluidDynamicsMatrixFree.html", tooltip="FluidDynamicsMatrixFree", fillcolor="#8ba5d4"];
51
52
navier_stokes_base:e -> navier_stokes_base_1:w [dir=back];
53
navier_stokes_base:e -> navier_stokes_base_2:w [dir=back];
54
navier_stokes_base:e -> navier_stokes_base_3:w [dir=back];
55
56
auxiliary_physics_1 [label="ConservativeLevelSet",href="https://chaos-polymtl.github.io/lethe/doxygen/classConservativeLevelSet.html"];
57
auxiliary_physics_2 [label="CahnHilliard",href="https://chaos-polymtl.github.io/lethe/doxygen/classCahnHilliard.html"];
58
auxiliary_physics_3 [label="HeatTransfer",href="https://chaos-polymtl.github.io/lethe/doxygen/classHeatTransfer.html"];
59
auxiliary_physics_4 [label="Tracer",href="https://chaos-polymtl.github.io/lethe/doxygen/classTracer.html"];
60
auxiliary_physics_5 [label="TimeHarmonicMaxwell",href="https://chaos-polymtl.github.io/lethe/doxygen/classTimeHarmonicMaxwell.html"];
61
62
auxiliary_physics:e -> auxiliary_physics_1:w [dir=back];
63
auxiliary_physics:e -> auxiliary_physics_2:w [dir=back];
64
auxiliary_physics:e -> auxiliary_physics_3:w [dir=back];
65
auxiliary_physics:e -> auxiliary_physics_4:w [dir=back];
66
auxiliary_physics:e -> auxiliary_physics_5:w [dir=back];
67
68
navier_stokes_base_1_1 [label=<<B>FluidDynamicsVANS</B> <br/>(lethe-fluid-vans)>,href="https://chaos-polymtl.github.io/lethe/doxygen/classFluidDynamicsVANS.html", tooltip="FluidDynamicsVANS", fillcolor="#8ba5d4"];
69
navier_stokes_base_1_2 [label=<<B>FluidDynamicsSharp</B> <br/>(lethe-fluid-sharp)>,href="https://chaos-polymtl.github.io/lethe/doxygen/classFluidDynamicsSharp.html", tooltip="FluidDynamicsSharp", fillcolor="#8ba5d4"];
70
navier_stokes_base_1_3 [label=<<B>FluidDynamicsNitsche</B> <br/>(lethe-fluid-nitsche)>,href="https://chaos-polymtl.github.io/lethe/doxygen/classFluidDynamicsNitsche.html", tooltip="FluidDynamicsNitsche", fillcolor="#8ba5d4"];
71
72
navier_stokes_base_1:e -> navier_stokes_base_1_1:w [dir=back];
73
navier_stokes_base_1:e -> navier_stokes_base_1_2:w [dir=back];
74
navier_stokes_base_1:e -> navier_stokes_base_1_3:w [dir=back];
75
76
navier_stokes_base_1_1_1 [label=<<B>CFDDEMSolver</B> <br/>(lethe-fluid-particles)>,href="https://chaos-polymtl.github.io/lethe/doxygen/classCFDDEMSolver.html", tooltip="CFDDEMSolver", fillcolor="#8ba5d4"];
77
78
navier_stokes_base_1_1:e -> navier_stokes_base_1_1_1:w [dir=back];
79
80
navier_stokes_base_3_1 [label=<<B>FluidDynamicsVANSMatrixFree</B> <br/>(lethe-fluid-vans-matrix-free)>,href="https://chaos-polymtl.github.io/lethe/doxygen/classFluidDynamicsVANSMatrixFree.html", tooltip="FluidDynamicsVANSMatrixFree", fillcolor="#8ba5d4"];
81
82
navier_stokes_base_3:e -> navier_stokes_base_3_1:w [dir=back];
83
84
navier_stokes_base_3_1_1 [label=<<B>CFDDEMMatrixFree</B> <br/>(lethe-fluid-particles-matrix-free)>,href="https://chaos-polymtl.github.io/lethe/doxygen/classCFDDEMMatrixFree.html", tooltip="CFDDEMMatrixFree", fillcolor="#8ba5d4"];
85
86
navier_stokes_base_3_1:e -> navier_stokes_base_3_1_1:w [dir=back];
87
}
88
* @enddot
89
*/
Generated by
1.15.0