ORB5  v4.9.4
antenna_mod Module Reference

Module for applying external charge and current density perturbations, or electrostatic and magnetic potentials. More...

Functions/Subroutines

subroutine, public init_module
 Initialize module. More...
 
subroutine, public init_field
 Initialize antenna's potential. More...
 
subroutine, public update_field (t)
 Update antenna's potential to a given time. More...
 

Variables

type(field_type), public phi
 Antenna's electrostatic potential. More...
 
real, dimension(:,:,:), allocatable field_t0_bspl
 Antenna's field at \(t=0\). More...
 
real, dimension(:,:,:), allocatable field_tquarter_bspl
 Antenna's field at \(t=\pi/(2\omega_\mathrm{ant})\). More...
 

Detailed Description

Module for applying external charge and current density perturbations, or electrostatic and magnetic potentials.

Author
N. Ohana
Date
07.2018

Function/Subroutine Documentation

◆ init_field()

subroutine, public antenna_mod::init_field

Initialize antenna's potential.

0. Allocate temporary field

  1. Select solver matrix
  2. Read profile if necessary
  3. Prepare diagnostics
  4. Loop over times when field must be built
  5. Build right-hand-side in Fourier space
  6. Change basis and impose boundary conditions
  7. Backsolve
  8. Go back to original basis
  9. Diagnose
  10. Broadcast to clones
  11. Fourier transform solution to real space
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ init_module()

subroutine, public antenna_mod::init_module

Initialize module.

  1. Initialize data structure
  2. Set which field should be evaluated at marker positions
  3. Set number of modes
  4. Allocate fields
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ update_field()

subroutine, public antenna_mod::update_field ( real, intent(in)  t)

Update antenna's potential to a given time.

See also
Time separation
Parameters
[in]tCurrent time

Variable Documentation

◆ field_t0_bspl

real, dimension(:,:,:), allocatable antenna_mod::field_t0_bspl
private

Antenna's field at \(t=0\).

◆ field_tquarter_bspl

real, dimension(:,:,:), allocatable antenna_mod::field_tquarter_bspl
private

Antenna's field at \(t=\pi/(2\omega_\mathrm{ant})\).

◆ phi

type(field_type), public antenna_mod::phi

Antenna's electrostatic potential.