RFOF - RF Library for Orbit Following Codes
RFOF_waves Module Reference

Module handling the RF wave fields. More...

List of all members.

Data Types

type  rf_wave_global
 Spline representation of the real part of the left hand polarized electric wave field. More...
type  rf_wave_local
 Structure including information about the local RF wave field. More...
type  rf_wave_mode_global
 Structure including information about the global RF wave field. More...

Public Member Functions

subroutine rf_wave_constructor (RFglobal, x1, x2, EfieldNormalisation, RFpower, freq, nphi, krho, kdia, kpar, Erho_norm, Edia_norm, Epar_norm, itm_waves_in)
 Constructor for RF wave fields.
subroutine rf_wave_destructor (wave)
 Destructor for fields in RF wave (not destructor for wave itself).
type(rf_wave_local) function get_rf_wave_local (x1, x2, x3, wi)
 Interpolate local wave field quantities at the point (x1,x2,x3) from the global wave field wi.
subroutine dummy_rf_wave_field (RFglobal)
 subroutine dummy_rf_wave_field(RFglobal)

Detailed Description

Module handling the RF wave fields.

Author:
T. Johnson
Date:
2010.05.26
Version:
"$Id: RFOF_waves.F90 188 2011-09-12 11:50:22Z tjohnson $"
Todo:
Implement interpolation of wave field on grid. (1) Build wrapper module for Diercx and derived type including spline coefficients (2) Use spline-type in rf_wave_global for each quantity you wish to spline (3) Add in constructor the generation of the spline coefficients

Definition at line 15 of file RFOF_waves.F90.


Member Function/Subroutine Documentation

subroutine RFOF_waves::rf_wave_constructor ( type(rf_wave_global), intent(out)  RFglobal,
real(8), dimension(:,:), intent(in)  x1,
real(8), dimension(:,:), intent(in)  x2,
real(8), dimension(:,:), intent(in)  EfieldNormalisation,
real(8), dimension(:,:), intent(in)  RFpower,
real(8), dimension(:), intent(in)  freq,
integer, dimension(:,:), intent(in)  nphi,
real(8), dimension(:,:,:,:), intent(in)  krho,
real(8), dimension(:,:,:,:), intent(in)  kdia,
real(8), dimension(:,:,:,:), intent(in)  kpar,
complex, dimension(:,:,:,:), intent(in), optional  Erho_norm,
complex, dimension(:,:,:,:), intent(in), optional  Edia_norm,
complex, dimension(:,:,:,:), intent(in), optional  Epar_norm,
type(type_waves), optional, target  itm_waves_in 
)

Constructor for RF wave fields.

Input:

Parameters:
x1First spatial coordinate
x2Second spatial coordinate
EfieldNormalisationInitial normlisation of the wave field; can be undated, e.g. to keep the absorbed power at RFpower.
RFpowerHeating power provided by wave field (normalise wave field to deliver this power).
freqWave frequency.
nphiToroidal mode number.
krhoWave vector component in the flux surface direction $\rho$.
kdiaWave vector component in the perpendicular-diamagnetic direction, $ -\nabla(\rho) \times B $, where $B$ is the magnetic field.
kparWave vector component in the direction parallel to the magnetic field.
Erho_normNormalised E-field directed in the flux surface direction $\rho$.
Edia_normNormalised E-field directed in the perpendicular-diamagnetic direction, $ -\nabla(\rho) \times B $, where $B$ is the magnetic field.
Epar_normNormalised E-field directed in the direction parallel to the magnetic field.
itm_waves_inITM datastructure WAVES.

Output:

Parameters:
RFglobalRF wave field structure

Definition at line 127 of file RFOF_waves.F90.

subroutine RFOF_waves::rf_wave_destructor ( type(rf_wave_global), intent(inout)  wave)

Destructor for fields in RF wave (not destructor for wave itself).

Input/Output:

Parameters:
waveRF wave field structure

Definition at line 239 of file RFOF_waves.F90.

type(rf_wave_local) function RFOF_waves::get_rf_wave_local ( real(8), intent(in)  x1,
real(8), intent(in)  x2,
real(8), intent(in)  x3,
type(rf_wave_global), intent(in)  wi 
)

Interpolate local wave field quantities at the point (x1,x2,x3) from the global wave field wi.

Input:

Parameters:
x1First spatial coordinate
x2Second spatial coordinate
x3Third spatial coordinate
wiGlobal wave field

Output:

Returns:
wo Local wave field; wi evaluated at (x1,x2,x3)

Definition at line 285 of file RFOF_waves.F90.

subroutine RFOF_waves::dummy_rf_wave_field ( type(rf_wave_global), intent(inout)  RFglobal)

subroutine dummy_rf_wave_field(RFglobal)

Parameters:
RFglobalRF wave field structure, including the E-field normalisation

Definition at line 360 of file RFOF_waves.F90.


The documentation for this module was generated from the following file: