slab_equilibrium_m Module

Definition of slab equilibrium N.b. this equilibrium is axisymmetric - phi, when required, is not used


Uses

  • module~~slab_equilibrium_m~~UsesGraph module~slab_equilibrium_m slab_equilibrium_m module~descriptors_m descriptors_m module~slab_equilibrium_m->module~descriptors_m module~equilibrium_m equilibrium_m module~slab_equilibrium_m->module~equilibrium_m module~params_equi_slab_m params_equi_slab_m module~slab_equilibrium_m->module~params_equi_slab_m module~precision_m precision_m module~slab_equilibrium_m->module~precision_m module~screen_io_m screen_io_m module~slab_equilibrium_m->module~screen_io_m module~descriptors_m->module~screen_io_m module~equilibrium_m->module~precision_m module~params_equi_slab_m->module~precision_m module~params_equi_slab_m->module~screen_io_m iso_fortran_env iso_fortran_env module~params_equi_slab_m->iso_fortran_env module~error_handling_m error_handling_m module~params_equi_slab_m->module~error_handling_m module~status_codes_m status_codes_m module~params_equi_slab_m->module~status_codes_m iso_c_binding iso_c_binding module~precision_m->iso_c_binding module~precision_m->iso_fortran_env mpi mpi module~precision_m->mpi netcdf netcdf module~precision_m->netcdf module~screen_io_m->module~precision_m module~screen_io_m->iso_fortran_env module~screen_io_m->netcdf module~error_handling_m->module~precision_m module~error_handling_m->module~screen_io_m module~error_handling_m->module~status_codes_m module~error_handling_m->mpi module~error_handling_m->netcdf module~comm_handling_m comm_handling_m module~error_handling_m->module~comm_handling_m module~comm_handling_m->mpi

Used by

  • module~~slab_equilibrium_m~~UsedByGraph module~slab_equilibrium_m slab_equilibrium_m module~coords_polar_m coords_polar_m module~coords_polar_m->module~slab_equilibrium_m module~equilibrium_factory_m equilibrium_factory_m module~equilibrium_factory_m->module~slab_equilibrium_m module~mesh_cart_m mesh_cart_m module~mesh_cart_m->module~slab_equilibrium_m module~polar_grid_m polar_grid_m module~polar_grid_m->module~slab_equilibrium_m module~polar_grid_m->module~coords_polar_m module~testfunctions_m testfunctions_m module~testfunctions_m->module~slab_equilibrium_m module~auxiliaries_test_diffusion_m auxiliaries_test_diffusion_m module~auxiliaries_test_diffusion_m->module~mesh_cart_m module~boundaries_perp_m boundaries_perp_m module~boundaries_perp_m->module~mesh_cart_m module~helmholtz_netcdfio_m helmholtz_netcdfio_m module~helmholtz_netcdfio_m->module~mesh_cart_m module~helmholtz_operator_m helmholtz_operator_m module~helmholtz_netcdfio_m->module~helmholtz_operator_m module~helmholtz_operator_m->module~mesh_cart_m module~helmholtz_operator_m->module~boundaries_perp_m module~immersed_factory_m immersed_factory_m module~immersed_factory_m->module~mesh_cart_m module~immersed_m immersed_m module~immersed_factory_m->module~immersed_m module~immersed_rho_m immersed_rho_m module~immersed_factory_m->module~immersed_rho_m module~immersed_trace_m immersed_trace_m module~immersed_factory_m->module~immersed_trace_m module~immersed_vessel_m immersed_vessel_m module~immersed_factory_m->module~immersed_vessel_m module~immersed_m->module~mesh_cart_m module~immersed_rho_m->module~mesh_cart_m module~immersed_rho_m->module~immersed_m module~immersed_trace_m->module~mesh_cart_m module~immersed_trace_m->module~immersed_m module~immersed_vessel_m->module~mesh_cart_m module~immersed_vessel_m->module~immersed_m module~map_factory_m map_factory_m module~map_factory_m->module~mesh_cart_m module~mesh_2d_netcdfio_s mesh_2d_netcdfio_s module~mesh_2d_netcdfio_s->module~mesh_cart_m module~mesh_cart_build_s mesh_cart_build_s module~mesh_cart_build_s->module~mesh_cart_m module~mesh_cart_communicate_s mesh_cart_communicate_s module~mesh_cart_communicate_s->module~mesh_cart_m module~mesh_cart_reorder_s mesh_cart_reorder_s module~mesh_cart_reorder_s->module~mesh_cart_m module~mesh_cart_s mesh_cart_s module~mesh_cart_s->module~mesh_cart_m module~multigrid_m multigrid_m module~multigrid_m->module~mesh_cart_m module~multigrid_m->module~boundaries_perp_m module~multigrid_solver_m multigrid_solver_m module~multigrid_solver_m->module~mesh_cart_m module~multigrid_solver_m->module~boundaries_perp_m module~multigrid_solver_m->module~helmholtz_operator_m module~multigrid_solver_m->module~multigrid_m module~splitting_m splitting_m module~multigrid_solver_m->module~splitting_m module~parbnd_taylor_m parbnd_taylor_m module~parbnd_taylor_m->module~mesh_cart_m module~polar_grid_s polar_grid_s module~polar_grid_s->module~polar_grid_m module~polar_map_factory_m polar_map_factory_m module~polar_map_factory_m->module~coords_polar_m module~polar_map_factory_m->module~mesh_cart_m module~polar_map_factory_m->module~polar_grid_m module~safety_factor_m safety_factor_m module~safety_factor_m->module~coords_polar_m module~snapshots_test_diffusion_m snapshots_test_diffusion_m module~snapshots_test_diffusion_m->module~mesh_cart_m module~splitting_m->module~mesh_cart_m module~vis_vtk3d_m vis_vtk3d_m module~vis_vtk3d_m->module~mesh_cart_m module~zonal_averages_factory_m zonal_averages_factory_m module~zonal_averages_factory_m->module~coords_polar_m module~zonal_averages_factory_m->module~mesh_cart_m module~zonal_averages_factory_m->module~polar_grid_m program~benchmark_helmholtz_solvers benchmark_helmholtz_solvers program~benchmark_helmholtz_solvers->module~equilibrium_factory_m program~benchmark_helmholtz_solvers->module~mesh_cart_m program~benchmark_helmholtz_solvers->module~testfunctions_m program~benchmark_helmholtz_solvers->module~helmholtz_netcdfio_m program~benchmark_helmholtz_solvers->module~multigrid_m module~helmholtz_solver_factory_m helmholtz_solver_factory_m program~benchmark_helmholtz_solvers->module~helmholtz_solver_factory_m program~diagnose_poincare diagnose_poincare program~diagnose_poincare->module~coords_polar_m program~diagnose_poincare->module~equilibrium_factory_m program~test_diffusion test_diffusion program~test_diffusion->module~equilibrium_factory_m program~test_diffusion->module~mesh_cart_m program~test_diffusion->module~auxiliaries_test_diffusion_m program~test_diffusion->module~map_factory_m program~test_diffusion->module~snapshots_test_diffusion_m program~test_diffusion->module~vis_vtk3d_m module~helmholtz_solver_direct_s helmholtz_solver_direct_s module~helmholtz_solver_direct_s->module~boundaries_perp_m module~helmholtz_solver_direct_s->module~helmholtz_operator_m module~helmholtz_solver_factory_m->module~multigrid_m module~helmholtz_solver_factory_m->module~splitting_m module~helmholtz_solver_mgmres_cxx_s helmholtz_solver_mgmres_cxx_s module~helmholtz_solver_mgmres_cxx_s->module~multigrid_m module~helmholtz_solver_petsc_s helmholtz_solver_petsc_s module~helmholtz_solver_petsc_s->module~boundaries_perp_m module~immersed_netcdf_s immersed_netcdf_s module~immersed_netcdf_s->module~immersed_m module~map_factory_s map_factory_s module~map_factory_s->module~map_factory_m module~multigrid_s multigrid_s module~multigrid_s->module~multigrid_m module~multigrid_solver_s multigrid_solver_s module~multigrid_solver_s->module~boundaries_perp_m module~multigrid_solver_s->module~multigrid_solver_m module~parbnd_taylor_netcdf_s parbnd_taylor_netcdf_s module~parbnd_taylor_netcdf_s->module~parbnd_taylor_m module~splitting_gauss_seidel_cpu_s splitting_gauss_seidel_cpu_s module~splitting_gauss_seidel_cpu_s->module~splitting_m module~splitting_gauss_seidel_redblack_cpu_s splitting_gauss_seidel_redblack_cpu_s module~splitting_gauss_seidel_redblack_cpu_s->module~splitting_m module~splitting_jacobi_cpu_s splitting_jacobi_cpu_s module~splitting_jacobi_cpu_s->module~splitting_m

Derived Types

type, public, extends(equilibrium_t) ::  slab_t

Type that represents the slab equilibrium

Components

Type Visibility Attributes Name Initial
logical, public :: initialized = .false.
real(kind=FP), public :: x0

Magnetic axis x = R/R0 (in normalised units)
real(kind=FP), public :: y0

Magnetic axis y = Z/R0 (in normalised units)
real(kind=FP), public :: phi0 = 0.0_FP

Magnetic axis phi
real(kind=FP), public :: xmin

Box limits
real(kind=FP), public :: xmax

Box limits
real(kind=FP), public :: ymin

Box limits
real(kind=FP), public :: ymax

Box limits
real(kind=FP), public :: rhomax

Global limits for rho (rho = normalised psi, n.b. there may also be region-specific limits defined in equi)
real(kind=FP), public :: rhomin

Global limits for rho (rho = normalised psi, n.b. there may also be region-specific limits defined in equi)

Type-Bound Procedures

procedure, public, pass(self) :: absb
procedure, public, pass(self) :: bpol
procedure, public :: init
procedure, public :: display
procedure, public :: debug
procedure, public :: is_axisymmetric
procedure, public :: rho
procedure, public :: bx
procedure, public :: by
procedure, public :: btor
procedure, public :: jacobian
procedure, public :: epol
procedure, public :: erad
procedure, public :: district
procedure, public :: in_vessel
procedure, public :: mag_axis_loc
procedure, public :: is_yperiodic

Functions

public function is_axisymmetric(self)

Arguments

Type IntentOptional Attributes Name
class(slab_t), intent(in) :: self

Return Value logical

public function rho(self, x, y, phi)

flux surface label = x

Arguments

Type IntentOptional Attributes Name
class(slab_t), intent(in) :: self
real(kind=FP), intent(in) :: x
real(kind=FP), intent(in) :: y
real(kind=FP), intent(in) :: phi

Return Value real(kind=fp)

public function bx(self, x, y, phi)

magnetic field component bx = 0

Arguments

Type IntentOptional Attributes Name
class(slab_t), intent(in) :: self
real(kind=FP), intent(in) :: x
real(kind=FP), intent(in) :: y
real(kind=FP), intent(in) :: phi

Return Value real(kind=fp)

public function by(self, x, y, phi)

magnetic field component by = 0

Arguments

Type IntentOptional Attributes Name
class(slab_t), intent(in) :: self
real(kind=FP), intent(in) :: x
real(kind=FP), intent(in) :: y
real(kind=FP), intent(in) :: phi

Return Value real(kind=fp)

public function btor(self, x, y, phi)

magnetic field strength normalised = 1

Arguments

Type IntentOptional Attributes Name
class(slab_t), intent(in) :: self
real(kind=FP), intent(in) :: x
real(kind=FP), intent(in) :: y
real(kind=FP), intent(in) :: phi

Return Value real(kind=fp)

public function jacobian(self, x, y, phi)

Jacobian of geometry (J=1)

Arguments

Type IntentOptional Attributes Name
class(slab_t), intent(in) :: self
real(kind=FP), intent(in) :: x
real(kind=FP), intent(in) :: y
real(kind=FP), intent(in) :: phi

Return Value real(kind=fp)

public function district(self, x, y, phi)

returns in which district point (x, y, phi) is (see module descriptors_m)

Arguments

Type IntentOptional Attributes Name
class(slab_t), intent(in) :: self
real(kind=FP), intent(in) :: x
real(kind=FP), intent(in) :: y
real(kind=FP), intent(in) :: phi

Return Value integer

public function in_vessel(self, x, y, phi)

For slab always inside vessel

Arguments

Type IntentOptional Attributes Name
class(slab_t), intent(in) :: self
real(kind=FP), intent(in) :: x
real(kind=FP), intent(in) :: y
real(kind=FP), intent(in) :: phi

Return Value logical

public pure function is_yperiodic(self)

Returns .true. if the equilibrium is y periodic and .false. otherwise

Arguments

Type IntentOptional Attributes Name
class(slab_t), intent(in) :: self

Return Value logical


Subroutines

public subroutine init(self, filename)

Initialises the slab equilibrium

Arguments

Type IntentOptional Attributes Name
class(slab_t), intent(inout) :: self

Instance of the type
character(len=*), intent(in), optional :: filename

Filename, where parameters are read from

public subroutine display(self)

Prints to console information about the equilibrium

Arguments

Type IntentOptional Attributes Name
class(slab_t), intent(in) :: self

public subroutine debug(self)

Prints to console information about the equilibrium

Arguments

Type IntentOptional Attributes Name
class(slab_t), intent(in) :: self

public subroutine epol(self, x, y, phi, epolx, epoly)

unit vector along poloidal (along flux surface) direction

Arguments

Type IntentOptional Attributes Name
class(slab_t), intent(in) :: self
real(kind=FP), intent(in) :: x
real(kind=FP), intent(in) :: y
real(kind=FP), intent(in) :: phi
real(kind=FP), intent(out) :: epolx

unit vector component in x-direction
real(kind=FP), intent(out) :: epoly

unit vector component in y-direction

public subroutine erad(self, x, y, phi, eradx, erady)

unit vector along radial (across flux surface) direction

Arguments

Type IntentOptional Attributes Name
class(slab_t), intent(in) :: self
real(kind=FP), intent(in) :: x
real(kind=FP), intent(in) :: y
real(kind=FP), intent(in) :: phi
real(kind=FP), intent(out) :: eradx

unit vector component in x-direction
real(kind=FP), intent(out) :: erady

unit vector component in y-direction

public subroutine mag_axis_loc(self, phi, axis_x, axis_y)

Returns the coordinates of magnetic axis

Arguments

Type IntentOptional Attributes Name
class(slab_t), intent(in) :: self

Instance of class
real(kind=FP), intent(in) :: phi

Toroidal angle
real(kind=FP), intent(out) :: axis_x

x-coordinate of the magnetic axis
real(kind=FP), intent(out) :: axis_y

y-coordinate of the magnetic axis