FESTIM/festim/__init__.py at e3da07f4cea82095a8dcfb414fbf34d014ed9f49 · jhdark/FESTIM · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
try:
    # Python 3.8+
    from importlib import metadata
except ImportError:
    try:
        import importlib_metadata as metadata
    except ImportError:
        __version__ = "unknown"

try:
    __version__ = metadata.version("FESTIM")
except Exception:
    __version__ = "unknown"


import sympy as sp

x, y, z, t = sp.symbols("x[0] x[1] x[2] t")
R = 8.314462618  # Gas constant J.mol-1.K-1
k_B = 8.6173303e-5  # Boltzmann constant eV.K-1

from .helpers import (
    update_expressions,
    kJmol_to_eV,
    extract_xdmf_labels,
    extract_xdmf_times,
    as_constant,
    as_expression,
    as_constant_or_expression,
    festim_print,
)

from .meshing.mesh import Mesh
from .meshing.mesh_1d import Mesh1D
from .meshing.mesh_from_vertices import MeshFromVertices
from .meshing.mesh_from_xdmf import MeshFromXDMF

from .temperature.temperature import Temperature
from .temperature.temperature_solver import HeatTransferProblem
from .temperature.temperature_from_xdmf import TemperatureFromXDMF

from .boundary_conditions.boundary_condition import BoundaryCondition
from .boundary_conditions.dirichlets.dirichlet_bc import (
    DirichletBC,
    BoundaryConditionTheta,
    BoundaryConditionExpression,
)
from .boundary_conditions.dirichlets.dc_imp import ImplantationDirichlet
from .boundary_conditions.dirichlets.sieverts_bc import SievertsBC
from .boundary_conditions.dirichlets.henrys_bc import HenrysBC
from .boundary_conditions.dirichlets.custom_dc import CustomDirichlet

from .boundary_conditions.fluxes.flux_bc import FluxBC
from .boundary_conditions.fluxes.recombination_flux import RecombinationFlux
from .boundary_conditions.fluxes.dissociation_flux import DissociationFlux
from .boundary_conditions.fluxes.convective_flux import ConvectiveFlux
from .boundary_conditions.fluxes.flux_custom import CustomFlux
from .boundary_conditions.fluxes.mass_flux import MassFlux
from .boundary_conditions.fluxes.surface_kinetics import SurfaceKinetics

from .exports.exports import Exports
from .exports.export import Export
from .exports.xdmf_export import XDMFExport
from .exports.trap_density_xdmf import TrapDensityXDMF

from .exports.derived_quantities.derived_quantity import (
    DerivedQuantity,
    VolumeQuantity,
    SurfaceQuantity,
)
from .exports.derived_quantities.surface_flux import (
    SurfaceFlux,
    SurfaceFluxCylindrical,
    SurfaceFluxSpherical,
)
from .exports.derived_quantities.hydrogen_flux import HydrogenFlux
from .exports.derived_quantities.thermal_flux import ThermalFlux
from .exports.derived_quantities.average_volume import (
    AverageVolume,
    AverageVolumeCylindrical,
    AverageVolumeSpherical,
)
from .exports.derived_quantities.maximum_volume import MaximumVolume
from .exports.derived_quantities.minimum_volume import MinimumVolume
from .exports.derived_quantities.minimum_surface import MinimumSurface
from .exports.derived_quantities.maximum_surface import MaximumSurface
from .exports.derived_quantities.total_surface import (
    TotalSurface,
    TotalSurfaceCylindrical,
    TotalSurfaceSpherical,
)
from .exports.derived_quantities.total_volume import (
    TotalVolume,
    TotalVolumeCylindrical,
    TotalVolumeSpherical,
)
from .exports.derived_quantities.total_volume import TotalVolume
from .exports.derived_quantities.average_surface import (
    AverageSurface,
    AverageSurfaceCylindrical,
    AverageSurfaceSpherical,
)
from .exports.derived_quantities.point_value import PointValue
from .exports.derived_quantities.adsorbed_hydrogen import AdsorbedHydrogen

from .exports.derived_quantities.derived_quantities import DerivedQuantities

from .exports.txt_export import TXTExport


from .settings import Settings
from .stepsize import Stepsize

from .sources.source import Source
from .sources.source_implantation_flux import ImplantationFlux
from .sources.radioactive_decay import RadioactiveDecay

from .materials.material import Material
from .materials.materials import Materials

from .concentration.concentration import Concentration
from .initial_condition import InitialCondition
from .concentration.mobile import Mobile
from .nonlinear_problem import Problem
from .concentration.theta import Theta

from .concentration.traps.trap import Trap
from .concentration.traps.traps import Traps
from .concentration.traps.extrinsic_trap import ExtrinsicTrapBase
from .concentration.traps.extrinsic_trap import ExtrinsicTrap
from .concentration.traps.neutron_induced_trap import NeutronInducedTrap

from .h_transport_problem import HTransportProblem

from .generic_simulation import Simulation