sll_m_maxwell_clamped_3d_trafo Module Reference

Description

Module interface to solve Maxwell's equations with coordinate transformation in 3D.

Author

Benedikt Perse

Derived types and interfaces
type	sll_t_maxwell_clamped_3d_trafo

Functions/Subroutines
subroutine	sll_s_compute_e_from_b_3d_trafo (self, delta_t, field_in, field_out)
	compute E from B using weak Ampere formulation More...
subroutine	sll_s_compute_b_from_e_3d_trafo (self, delta_t, field_in, field_out)
	Compute B from E using strong 3D Faraday equation for spline coefficients. More...
subroutine	sll_s_compute_curl_part_3d_trafo (self, delta_t, efield, bfield, betar)
	Solve curl part of Maxwell's equations. More...
subroutine	sll_s_compute_e_from_rho_3d_trafo (self, field_in, field_out)
	Compute E_i from rho_i integrated over the time interval using weak Poisson's equation ( rho = G^T M_1 G \phi, e = G \phi ) More...
subroutine	sll_s_compute_rho_from_e_3d_trafo (self, field_in, field_out)
	compute rho from e using weak Gauss law ( rho = G^T M_1 e ) More...
subroutine	sll_s_compute_e_from_j_3d_trafo (self, current, E, component)
	Compute E_i from j_i integrated over the time interval using weak Ampere formulation, delta_t is already included. More...
subroutine	sll_s_compute_phi_from_rho_3d_trafo (self, field_in, field_out, efield_dofs)
	Compute phi from rho_i integrated over the time interval. More...
subroutine	sll_s_compute_phi_from_j_3d_trafo (self, field_in, field_out, efield_dofs)
	Compute phi from j_i integrated over the time interval, delta_t is already included. More...
subroutine	sll_s_compute_rhs_trafo (self, form, component, coefs_dofs, func1, func2, func3)
	Compute the FEM right-hand-side for a given function f and periodic splines of given degree Its components are $\int f(F(\xi)) N_i(F(\xi)) J_F d\xi$ where $N_i$ is the B-spline starting at $\xi_i$. More...
subroutine	rhs_zeroform (self, deg, func, coefs_dofs)
	Compute $\int f(F(\xi)) N_i(\xi) J_F(\xi) d\xi$ for scalar function f, where $N_i$ is the B-spline starting at $\xi_i$, replace modulo(a,b) by a-floor(a/b)*b. More...
subroutine	rhs_oneform (self, deg, func1, func2, func3, component, coefs_dofs)
	Compute $\int f(F(\xi))\cdot DF^{-T}(\xi) N_i(\xi) J_F(\xi) d\xi$ for vector function f, where $N_i$ is the B-spline starting at $\xi_i$. More...
subroutine	rhs_twoform (self, deg, func1, func2, func3, component, coefs_dofs)
	Compute $\int f(F(\xi))\cdot DF(\xi) N_i(\xi) d\xi$ for vector function f, where $N_i$ is the B-spline starting at $\xi_i$. More...
subroutine	l2projection_3d_trafo (self, form, component, coefs_dofs, func1, func2, func3)
	Compute the L2 projection of a given function f on periodic splines of given degree. More...
real(kind=f64) function	l2norm_squared_3d_trafo (self, coefs, form, component)
	Compute square of the L2norm. More...
real(kind=f64) function	inner_product_3d_trafo (self, coefs1, coefs2, form, component)
	Compute inner product. More...
subroutine	init_3d_trafo (self, domain, n_cells, s_deg_0, boundary, map, mass_tolerance, poisson_tolerance, solver_tolerance, adiabatic_electrons, profile)
	Initialization. More...
subroutine	init_from_file_3d_trafo (self, domain, n_cells, s_deg_0, boundary, map, nml_file, adiabatic_electrons, profile)
	Initialization from nml file. More...
subroutine	free_3d_trafo (self)
	Finalization. More...
subroutine	multiply_g (self, field_in, field_out)
	Multiply by dicrete gradient matrix. More...
subroutine	multiply_gt (self, field_in, field_out)
	Multiply by transpose of dicrete gradient matrix. More...
subroutine	multiply_c (self, field_in, field_out)
	Multiply by discrete curl matrix. More...
subroutine	multiply_ct (self, field_in, field_out)
	Multiply by transpose of discrete curl matrix. More...
subroutine	multiply_mass_3d_trafo (self, deg, coefs_in, coefs_out)
	Multiply by the mass matrix. More...
subroutine	multiply_mass_inverse_3d_trafo (self, form, coefs_in, coefs_out)
	Multiply by the inverse mass matrix. More...

Function/Subroutine Documentation

free_3d_trafo()

subroutine sll_m_maxwell_clamped_3d_trafo::free_3d_trafo ( class(sll_t_maxwell_clamped_3d_trafo)  self )

private

Finalization.

Parameters

self	Maxwell_Clamped solver class

Definition at line 1317 of file sll_m_maxwell_clamped_3d_trafo.F90.

Here is the call graph for this function:

init_3d_trafo()

subroutine sll_m_maxwell_clamped_3d_trafo::init_3d_trafo ( class(sll_t_maxwell_clamped_3d_trafo), intent(inout)  self, real(kind=f64), dimension(3,2), intent(in)  domain, integer(kind=i32), dimension(3), intent(in)  n_cells, integer(kind=i32), dimension(3), intent(in)  s_deg_0, integer(kind=i32), dimension(3), intent(in)  boundary, type(sll_t_mapping_3d), intent(inout), target  map, real(kind=f64), intent(in), optional  mass_tolerance, real(kind=f64), intent(in), optional  poisson_tolerance, real(kind=f64), intent(in), optional  solver_tolerance, logical, intent(in), optional  adiabatic_electrons, type(sll_t_profile_functions), intent(in), optional  profile  )

private

Initialization.

Parameters

[in,out]	self	Maxwell_Clamped solver class
[in]	n_cells	number of degrees of freedom (here number of cells and grid points)
[in]	s_deg_0	highest spline degree
[in]	boundary	field boundary conditions
[in,out]	map	coordinate transformation
[in]	mass_tolerance	tolerance for mass solver
[in]	poisson_tolerance	tolerance for Poisson solver
[in]	solver_tolerance	tolerance for Schur complement solver
[in]	adiabatic_electrons	flag if adiabatic electrons are used
[in]	profile	temperature and density profiles

Definition at line 937 of file sll_m_maxwell_clamped_3d_trafo.F90.

Here is the call graph for this function:

init_from_file_3d_trafo()

subroutine sll_m_maxwell_clamped_3d_trafo::init_from_file_3d_trafo ( class(sll_t_maxwell_clamped_3d_trafo), intent(inout)  self, real(kind=f64), dimension(3,2), intent(in)  domain, integer(kind=i32), dimension(3), intent(in)  n_cells, integer(kind=i32), dimension(3), intent(in)  s_deg_0, integer(kind=i32), dimension(3), intent(in)  boundary, type(sll_t_mapping_3d), intent(inout), target  map, character(len=*), intent(in)  nml_file, logical, intent(in), optional  adiabatic_electrons, type(sll_t_profile_functions), intent(in), optional  profile  )

private

Initialization from nml file.

Parameters

[in,out]	self	Maxwell_Clamped solver class
[in]	n_cells	number of degrees of freedom (here number of cells and grid points)
[in]	s_deg_0	highest spline degree
[in,out]	map	coordinate transformation
[in]	nml_file	nml-file
[in]	adiabatic_electrons	flag if adiabatic electrons are used
[in]	profile	temperature and density profiles

Definition at line 1234 of file sll_m_maxwell_clamped_3d_trafo.F90.

Here is the call graph for this function:

inner_product_3d_trafo()

real(kind=f64) function sll_m_maxwell_clamped_3d_trafo::inner_product_3d_trafo ( class(sll_t_maxwell_clamped_3d_trafo)  self, real(kind=f64), dimension(:)  coefs1, real(kind=f64), dimension(:)  coefs2, integer(kind=i32)  form, integer(kind=i32), optional  component  )

private

Compute inner product.

Parameters

self	Maxwell_Clamped solver class
coefs1	Coefficient for each DoF
coefs2	Coefficient for each DoF
form	Specify 0,1,2 or 3-form
component	Specify the component of the form

Returns

Result: squared L2 norm

Definition at line 879 of file sll_m_maxwell_clamped_3d_trafo.F90.

Here is the caller graph for this function:

l2norm_squared_3d_trafo()

real(kind=f64) function sll_m_maxwell_clamped_3d_trafo::l2norm_squared_3d_trafo ( class(sll_t_maxwell_clamped_3d_trafo)  self, real(kind=f64), dimension(:)  coefs, integer(kind=i32)  form, integer(kind=i32)  component  )

private

Compute square of the L2norm.

Parameters

self	Maxwell_Clamped solver class
coefs	Coefficient for each DoF
form	Specify 0,1,2 or 3-form
component	Specify the component of the form

Returns

Result: squared L2 norm

Definition at line 866 of file sll_m_maxwell_clamped_3d_trafo.F90.

Here is the call graph for this function:

l2projection_3d_trafo()

subroutine sll_m_maxwell_clamped_3d_trafo::l2projection_3d_trafo ( class(sll_t_maxwell_clamped_3d_trafo)  self, integer(kind=i32), intent(in)  form, integer(kind=i32), intent(in)  component, real(kind=f64), dimension(:), intent(out)  coefs_dofs, procedure(sll_i_function_3d_real64)  func1, procedure(sll_i_function_3d_real64), optional  func2, procedure(sll_i_function_3d_real64), optional  func3  )

private

Compute the L2 projection of a given function f on periodic splines of given degree.

Parameters

	self	Maxwell_Clamped solver class
[in]	form	Specify if the function is a0,1,2 or 3-form
[in]	component	Specify the component of the function
[out]	coefs_dofs	Finite Element right-hand-side
	func1	Function first component
	func2	Function second component
	func3	Function third component

Definition at line 826 of file sll_m_maxwell_clamped_3d_trafo.F90.

Here is the call graph for this function:

multiply_c()

subroutine sll_m_maxwell_clamped_3d_trafo::multiply_c ( class(sll_t_maxwell_clamped_3d_trafo)  self, real(kind=f64), dimension(:), intent(in)  field_in, real(kind=f64), dimension(:), intent(out)  field_out  )

private

Multiply by discrete curl matrix.

Parameters

	self	Maxwell_Clamped solver class
[out]	field_out	G^T*field_in

Definition at line 1368 of file sll_m_maxwell_clamped_3d_trafo.F90.

Here is the call graph for this function:

multiply_ct()

subroutine sll_m_maxwell_clamped_3d_trafo::multiply_ct ( class(sll_t_maxwell_clamped_3d_trafo)  self, real(kind=f64), dimension(:), intent(in)  field_in, real(kind=f64), dimension(:), intent(out)  field_out  )

private

Multiply by transpose of discrete curl matrix.

Parameters

	self	Maxwell_Clamped solver class
[out]	field_out	C^T*field_in

Definition at line 1379 of file sll_m_maxwell_clamped_3d_trafo.F90.

Here is the call graph for this function:

multiply_g()

subroutine sll_m_maxwell_clamped_3d_trafo::multiply_g ( class(sll_t_maxwell_clamped_3d_trafo)  self, real(kind=f64), dimension(:), intent(in)  field_in, real(kind=f64), dimension(:), intent(out)  field_out  )

private

Multiply by dicrete gradient matrix.

Parameters

	self	Maxwell_Clamped solver class
[out]	field_out	G*field_in

Definition at line 1346 of file sll_m_maxwell_clamped_3d_trafo.F90.

Here is the call graph for this function:

multiply_gt()

subroutine sll_m_maxwell_clamped_3d_trafo::multiply_gt ( class(sll_t_maxwell_clamped_3d_trafo)  self, real(kind=f64), dimension(:), intent(in)  field_in, real(kind=f64), dimension(:), intent(out)  field_out  )

private

Multiply by transpose of dicrete gradient matrix.

Parameters

	self	Maxwell_Clamped solver class
[out]	field_out	G^T*field_in

Definition at line 1357 of file sll_m_maxwell_clamped_3d_trafo.F90.

Here is the call graph for this function:

multiply_mass_3d_trafo()

subroutine sll_m_maxwell_clamped_3d_trafo::multiply_mass_3d_trafo ( class(sll_t_maxwell_clamped_3d_trafo)  self, integer(kind=i32), dimension(:), intent(in)  deg, real(kind=f64), dimension(:), intent(in)  coefs_in, real(kind=f64), dimension(:), intent(out)  coefs_out  )

private

Multiply by the mass matrix.

Parameters

	self	Maxwell_Clamped solver class
[in]	deg	deg/form specifies if we multiply the mass to a 1- or 2-form or a mix of both
[in]	coefs_in	Coefficient for each DoF
[out]	coefs_out	Coefficient for each DoF

Definition at line 1390 of file sll_m_maxwell_clamped_3d_trafo.F90.

multiply_mass_inverse_3d_trafo()

subroutine sll_m_maxwell_clamped_3d_trafo::multiply_mass_inverse_3d_trafo ( class(sll_t_maxwell_clamped_3d_trafo)  self, integer(kind=i32), intent(in)  form, real(kind=f64), dimension(:), intent(in)  coefs_in, real(kind=f64), dimension(:), intent(out)  coefs_out  )

private

Multiply by the inverse mass matrix.

Parameters

	self	Maxwell_Clamped solver class
[in]	form	form specifies the form (Note: 0 for 0-form, 1 for 1-form, 2 for 2-form, 3 for 0-1-form mix)
[in]	coefs_in	Coefficient for each DoF
[out]	coefs_out	Coefficient for each DoF

Definition at line 1417 of file sll_m_maxwell_clamped_3d_trafo.F90.

rhs_oneform()

subroutine sll_m_maxwell_clamped_3d_trafo::rhs_oneform ( class(sll_t_maxwell_clamped_3d_trafo)  self, integer(kind=i32), dimension(3), intent(in)  deg, procedure(sll_i_function_3d_real64)  func1, procedure(sll_i_function_3d_real64)  func2, procedure(sll_i_function_3d_real64)  func3, integer(kind=i32), intent(in)  component, real(kind=f64), dimension(:), intent(out)  coefs_dofs  )

private

Compute $\int f(F(\xi))\cdot DF^{-T}(\xi) N_i(\xi) J_F(\xi) d\xi$ for vector function f, where $N_i$ is the B-spline starting at $\xi_i$.

Parameters

	self	Maxwell_Clamped solver class
[in]	deg	spline degree
	func1	Function first component
	func2	Function second component
	func3	Function third component
[in]	component	Specify the component of the function
[out]	coefs_dofs	Finite Element right-hand-side

Definition at line 505 of file sll_m_maxwell_clamped_3d_trafo.F90.

Here is the call graph for this function:

Here is the caller graph for this function:

rhs_twoform()

subroutine sll_m_maxwell_clamped_3d_trafo::rhs_twoform ( class(sll_t_maxwell_clamped_3d_trafo)  self, integer(kind=i32), dimension(3), intent(in)  deg, procedure(sll_i_function_3d_real64)  func1, procedure(sll_i_function_3d_real64)  func2, procedure(sll_i_function_3d_real64)  func3, integer(kind=i32), intent(in)  component, real(kind=f64), dimension(:), intent(out)  coefs_dofs  )

private

Compute $\int f(F(\xi))\cdot DF(\xi) N_i(\xi) d\xi$ for vector function f, where $N_i$ is the B-spline starting at $\xi_i$.

Parameters

	self	Maxwell_Clamped solver class
[in]	deg	spline degree
	func1	Function first component
	func2	Function second component
	func3	Function third component
[in]	component	Specify the component of the function
[out]	coefs_dofs	Finite Element right-hand-side

Definition at line 667 of file sll_m_maxwell_clamped_3d_trafo.F90.

Here is the call graph for this function:

Here is the caller graph for this function:

rhs_zeroform()

subroutine sll_m_maxwell_clamped_3d_trafo::rhs_zeroform ( class(sll_t_maxwell_clamped_3d_trafo)  self, integer(kind=i32), dimension(3), intent(in)  deg, procedure(sll_i_function_3d_real64)  func, real(kind=f64), dimension(:), intent(out)  coefs_dofs  )

private

Compute $\int f(F(\xi)) N_i(\xi) J_F(\xi) d\xi$ for scalar function f, where $N_i$ is the B-spline starting at $\xi_i$, replace modulo(a,b) by a-floor(a/b)*b.

Parameters

	self	Maxwell_Clamped solver class
[in]	deg	spline degree
	func	function
[out]	coefs_dofs	Finite Element right-hand-side

Definition at line 352 of file sll_m_maxwell_clamped_3d_trafo.F90.

Here is the call graph for this function:

Here is the caller graph for this function:

sll_s_compute_b_from_e_3d_trafo()

subroutine sll_m_maxwell_clamped_3d_trafo::sll_s_compute_b_from_e_3d_trafo ( class(sll_t_maxwell_clamped_3d_trafo)  self, real(kind=f64), intent(in)  delta_t, real(kind=f64), dimension(:), intent(in)  field_in, real(kind=f64), dimension(:), intent(inout)  field_out  )

private

Compute B from E using strong 3D Faraday equation for spline coefficients.

Parameters

	self	Maxwell_Clamped solver class
[in]	delta_t	time step
[in]	field_in	E
[in,out]	field_out	B

Definition at line 187 of file sll_m_maxwell_clamped_3d_trafo.F90.

sll_s_compute_curl_part_3d_trafo()

subroutine sll_m_maxwell_clamped_3d_trafo::sll_s_compute_curl_part_3d_trafo ( class(sll_t_maxwell_clamped_3d_trafo)  self, intent(in)  delta_t, dimension(:), intent(inout)  efield, dimension(:), intent(inout)  bfield, optional  betar  )

private

Solve curl part of Maxwell's equations.

Parameters

self	Maxwell solver class

Definition at line 201 of file sll_m_maxwell_clamped_3d_trafo.F90.

sll_s_compute_e_from_b_3d_trafo()

subroutine sll_m_maxwell_clamped_3d_trafo::sll_s_compute_e_from_b_3d_trafo ( class(sll_t_maxwell_clamped_3d_trafo)  self, real(kind=f64), intent(in)  delta_t, real(kind=f64), dimension(:), intent(in)  field_in, real(kind=f64), dimension(:), intent(inout)  field_out  )

private

compute E from B using weak Ampere formulation

Parameters

	self	Maxwell_Clamped solver class
[in]	delta_t	Time step
[in]	field_in	B
[in,out]	field_out	E

Definition at line 168 of file sll_m_maxwell_clamped_3d_trafo.F90.

sll_s_compute_e_from_j_3d_trafo()

subroutine sll_m_maxwell_clamped_3d_trafo::sll_s_compute_e_from_j_3d_trafo ( class(sll_t_maxwell_clamped_3d_trafo)  self, real(kind=f64), dimension(:), intent(in)  current, real(kind=f64), dimension(:), intent(inout)  E, integer(kind=i32), intent(in), optional  component  )

private

Compute E_i from j_i integrated over the time interval using weak Ampere formulation, delta_t is already included.

Parameters

	self	Maxwell_Clamped solver class
[in]	current	Current integrated over time interval
[in,out]	e	Updated electric field

Definition at line 273 of file sll_m_maxwell_clamped_3d_trafo.F90.

sll_s_compute_e_from_rho_3d_trafo()

subroutine sll_m_maxwell_clamped_3d_trafo::sll_s_compute_e_from_rho_3d_trafo ( class(sll_t_maxwell_clamped_3d_trafo)  self, real(kind=f64), dimension(:), intent(in)  field_in, real(kind=f64), dimension(:), intent(out)  field_out  )

private

Compute E_i from rho_i integrated over the time interval using weak Poisson's equation ( rho = G^T M_1 G \phi, e = G \phi )

Parameters

	self	Maxwell_Clamped solver class
[in]	field_in	rho
[out]	field_out	E

Definition at line 245 of file sll_m_maxwell_clamped_3d_trafo.F90.

sll_s_compute_phi_from_j_3d_trafo()

subroutine sll_m_maxwell_clamped_3d_trafo::sll_s_compute_phi_from_j_3d_trafo ( class(sll_t_maxwell_clamped_3d_trafo)  self, real(kind=f64), dimension(:), intent(in)  field_in, real(kind=f64), dimension(:), intent(inout)  field_out, real(kind=f64), dimension(:), intent(out)  efield_dofs  )

private

Compute phi from j_i integrated over the time interval, delta_t is already included.

Parameters

	self	Maxwell_Clamped solver class
[in]	field_in	Current integrated over time interval
[in,out]	field_out	phi
[out]	efield_dofs	E

Definition at line 304 of file sll_m_maxwell_clamped_3d_trafo.F90.

sll_s_compute_phi_from_rho_3d_trafo()

subroutine sll_m_maxwell_clamped_3d_trafo::sll_s_compute_phi_from_rho_3d_trafo ( class(sll_t_maxwell_clamped_3d_trafo)  self, real(kind=f64), dimension(:), intent(in)  field_in, real(kind=f64), dimension(:), intent(inout)  field_out, real(kind=f64), dimension(:), intent(out)  efield_dofs  )

private

Compute phi from rho_i integrated over the time interval.

Parameters

	self	Maxwell_Clamped solver class
[in]	field_in	rho
[in,out]	field_out	phi
[out]	efield_dofs	E

Definition at line 290 of file sll_m_maxwell_clamped_3d_trafo.F90.

sll_s_compute_rho_from_e_3d_trafo()

subroutine sll_m_maxwell_clamped_3d_trafo::sll_s_compute_rho_from_e_3d_trafo ( class(sll_t_maxwell_clamped_3d_trafo)  self, real(kind=f64), dimension(:), intent(in)  field_in, real(kind=f64), dimension(:), intent(out)  field_out  )

private

compute rho from e using weak Gauss law ( rho = G^T M_1 e )

Parameters

	self	Maxwell_Clamped solver class
[in]	field_in	E
[out]	field_out	rho

Definition at line 260 of file sll_m_maxwell_clamped_3d_trafo.F90.

sll_s_compute_rhs_trafo()

subroutine sll_m_maxwell_clamped_3d_trafo::sll_s_compute_rhs_trafo ( class(sll_t_maxwell_clamped_3d_trafo)  self, integer(kind=i32), intent(in)  form, integer(kind=i32), intent(in)  component, real(kind=f64), dimension(:), intent(out)  coefs_dofs, procedure(sll_i_function_3d_real64)  func1, procedure(sll_i_function_3d_real64), optional  func2, procedure(sll_i_function_3d_real64), optional  func3  )

private

Compute the FEM right-hand-side for a given function f and periodic splines of given degree Its components are $\int f(F(\xi)) N_i(F(\xi)) J_F d\xi$ where $N_i$ is the B-spline starting at $\xi_i$.

Parameters

	self	Maxwell_Clamped solver class
[in]	form	Specify if the function is a0,1,2 or 3-form
[in]	component	Specify the component of the function
[out]	coefs_dofs	Finite Element right-hand-side
	func1	Function first component
	func2	Function second component
	func3	Function third component

Definition at line 322 of file sll_m_maxwell_clamped_3d_trafo.F90.

Here is the call graph for this function:

Here is the caller graph for this function: