VERB_code_2.2  2
 All Classes Namespaces Files Functions Variables Typedefs Macros Pages
DiffusionCoefficient Class Reference

#include <DiffusionCoefficient.h>

Public Member Functions

double Scale (double Kp)
 Function, that scale diffusion coefficients. More...
 
void Create_Dxx (DxxParameters_structure DxxParameters, Grid &grid)
 Create diffusion coefficients. More...
 
bool LoadDiffusionCoefficient (GridElement &L, GridElement &pc, GridElement &alpha, string D_filename, string filetype="IFT_GRID")
 
bool LoadDiffusionCoefficientFromFileWithGrid (GridElement &L, GridElement &pc, GridElement &alpha, string D_filename, string gridOrder="IFT_GRID_LPA")
 Load Dxx from the file with Grid. More...
 
bool LoadDiffusionCoefficientFromPlaneFile (GridElement &L, GridElement &pc, GridElement &alpha, string D_filename)
 Load Dxx from file without grid. More...
 
void Calculate (GridElement &L, GridElement &epc, GridElement &alpha, DxxParameters_structure DxxParameters)
 function calculare Dxx More...
 
void MakeDLL (double Kp)
 Making DLL. More...
 
void MakeDLL (GridElement &L, GridElement &pc, GridElement &alpha, double Kp, string DLLType="DLLT_B")
 Making DLL. More...
 
void MakeDLL_B (GridElement &L, GridElement &pc, GridElement &alpha, double Kp)
 Making DLL. More...
 
void MakeDLL_FAKE (GridElement &L, GridElement &pc, GridElement &alpha, double Kp)
 Making DLL. More...
 
void MakeDLL_BE_res (GridElement &L, GridElement &pc, GridElement &alpha, double Kp)
 Making DLL. More...
 
void MakeDLL_BE (GridElement &L, GridElement &pc, GridElement &alpha, double Kp)
 Making DLL. More...
 
void MakeDLL100 (GridElement &L, GridElement &pc, GridElement &alpha, double Kp)
 Making DLL. More...
 
void MakeDLL_Ozeke (GridElement &L, GridElement &pc, GridElement &alpha, double Kp)
 Making DLL_M. More...
 
void MakeDLL_Ozeke_ME (GridElement &L, GridElement &pc, GridElement &alpha, double Kp)
 Making DLL_ME. More...
 

Public Attributes

Matrix3D< double > arr
 
bool Dxx_initialized
 flag, indicated that the initialization was passed More...
 
DxxParameters_structure DxxParameters
 
string type
 Type of the diffusion coefficient: Daa, Dpp, Dpa etc... Described in types.h file as an enumeration. More...
 
bool is_active
 flag, if is enabled right now More...
 
bool useScale
 flag, if scale is applyable More...
 

Detailed Description

Class DiffusionCoefficient holds diffusion coefficient matrix and routines to load and calculate it. It gets DiffusionCoefficientParameters_structure as an input with all waves parameters.

Definition at line 22 of file DiffusionCoefficient.h.

Member Function Documentation

double DiffusionCoefficient::Scale ( double  Kp)

Function, that scale diffusion coefficients.

Scaling procedure

Todo:
Upgrade scaling diffusion coefficients procedure with scaling according to external array

Definition at line 476 of file DiffusionCoefficient.cpp.

void DiffusionCoefficient::Create_Dxx ( DxxParameters_structure  DxxParameters,
Grid grid 
)

Create diffusion coefficients.

Function Get - retutn diffusion coefficient by loading or calculating it Two way of call function: With or without grid parameter If it called without grid parameter, it takes grid stored in the class

Todo:
Remove grid from the class DiffusionCoefficients and remove functions, these assume it there
Parameters
DxxParameters- diffusion coefficients param structure

Definition at line 39 of file DiffusionCoefficient.cpp.

References error_msg::add(), Grid::alpha, GridElement::arr, DxxParameters_structure::DxxName, DxxParameters_structure::DxxType, Output::echo(), Grid::epc, err, DxxParameters_structure::filename, DxxParameters_structure::filetype, Grid::L, DxxParameters_structure::loadOrCalculate, DxxParameters_structure::MLT_averaging, DxxParameters_structure::multiplicator, Grid::pc, GridElement::size, Matrix3D< T >::times(), DxxParameters_structure::useScale, DxxParameters_structure::waveName, and error_msg::what().

bool DiffusionCoefficient::LoadDiffusionCoefficient ( GridElement L,
GridElement pc,
GridElement alpha,
string  D_filename,
string  filetype = "IFT_GRID" 
)

Loads diffusion coefficients Call other functions depends on filetupe - file type

Parameters
&L- Grid element - L
&pc- Grid element - pc
&alpha- One more grid element - alpha
D_filename- filename to load diffusion coefficient from
filetype= IFT_GRID grid type inside the file (yes, it can be different)

Loading coefficient from file runs loading function according file format (filetype)

Definition at line 162 of file DiffusionCoefficient.cpp.

References Output::echo().

bool DiffusionCoefficient::LoadDiffusionCoefficientFromFileWithGrid ( GridElement L,
GridElement epc,
GridElement alpha,
string  D_filename,
string  gridOrder = "IFT_GRID_LPA" 
)

Load Dxx from the file with Grid.

Loading coef from file with grid

Definition at line 217 of file DiffusionCoefficient.cpp.

References GridElement::arr, Output::echo(), err, and GridElement::size.

bool DiffusionCoefficient::LoadDiffusionCoefficientFromPlaneFile ( GridElement L,
GridElement pc,
GridElement alpha,
string  D_filename 
)

Load Dxx from file without grid.

Loading coefficient from plane file

Definition at line 187 of file DiffusionCoefficient.cpp.

References GridElement::size.

void DiffusionCoefficient::Calculate ( GridElement L,
GridElement epc,
GridElement Alpha,
DxxParameters_structure  DxxParameters 
)

function calculare Dxx

Calculating the diffusion coefficients

Parameters
&L- Grid element L
&epc- Grid element epc
&Alpha- Grid element Alpha
DxxParameters- Dxx parameters structure

Definition at line 116 of file DiffusionCoefficient.cpp.

References GridElement::arr, Dxx_ba(), DxxParameters_structure::DxxName, DxxParameters_structure::DxxType, Output::echo(), int_Daa_loc(), int_Dpa_loc(), int_Dpp_loc(), VC::mc2, min_Dxx, GridElement::size, and DxxParameters_structure::waveName.

void DiffusionCoefficient::MakeDLL ( double  Kp)

Making DLL.

void DiffusionCoefficient::MakeDLL ( GridElement L,
GridElement pc,
GridElement alpha,
double  Kp,
string  DLLType = "DLLT_B" 
)

Making DLL.

Making DLL

Definition at line 281 of file DiffusionCoefficient.cpp.

void DiffusionCoefficient::MakeDLL_B ( GridElement L,
GridElement pc,
GridElement alpha,
double  Kp 
)

Making DLL.

Making DLL

Definition at line 306 of file DiffusionCoefficient.cpp.

References GridElement::arr, Df(), and GridElement::size.

void DiffusionCoefficient::MakeDLL_FAKE ( GridElement L,
GridElement pc,
GridElement alpha,
double  Kp 
)

Making DLL.

Making DLL

Definition at line 320 of file DiffusionCoefficient.cpp.

References GridElement::arr, Df(), and GridElement::size.

void DiffusionCoefficient::MakeDLL_BE_res ( GridElement L,
GridElement pc,
GridElement alpha,
double  Kp 
)

Making DLL.

void DiffusionCoefficient::MakeDLL_BE ( GridElement L,
GridElement pc,
GridElement alpha,
double  Kp 
)

Making DLL.

Other version of DLL making procedure

Definition at line 333 of file DiffusionCoefficient.cpp.

References GridElement::arr, Df(), VF::Dfe(), VF::Kfunc(), and GridElement::size.

void DiffusionCoefficient::MakeDLL100 ( GridElement L,
GridElement pc,
GridElement alpha,
double  Kp 
)

Making DLL.

Other version of DLL making procedure

Definition at line 355 of file DiffusionCoefficient.cpp.

References GridElement::arr, Df(), VF::max(), and GridElement::size.

void DiffusionCoefficient::MakeDLL_Ozeke ( GridElement L,
GridElement pc,
GridElement alpha,
double  Kp 
)

Making DLL_M.

Making DLL Ozeke WARNING! This code uses prepublication values! WARNING! Previous version of DLL: Ozeke, L. G., I. R. Mann, K. R. Murphy, I. J. Rae, D. K. Milling, S. R. Elkington, A. A. A. Chan, and H. J. Singer (2012), ULF Wave Derived Radiation Belt Radial Diffusion Coefficients, J. Geophys. Res., doi:10.1029/2011JA017463, in press. (accepted 23 February 2012) Magnetic component

Definition at line 376 of file DiffusionCoefficient.cpp.

References GridElement::arr, Df_Ozeke(), and GridElement::size.

void DiffusionCoefficient::MakeDLL_Ozeke_ME ( GridElement L,
GridElement pc,
GridElement alpha,
double  Kp 
)

Making DLL_ME.

Making DLL Ozeke WARNING! This code uses prepublication values! WARNING! Previous version of DLL: Ozeke, L. G., I. R. Mann, K. R. Murphy, I. J. Rae, D. K. Milling, S. R. Elkington, A. A. A. Chan, and H. J. Singer (2012), ULF Wave Derived Radiation Belt Radial Diffusion Coefficients, J. Geophys. Res., doi:10.1029/2011JA017463, in press. (accepted 23 February 2012) Magnetic and Electric component

Definition at line 395 of file DiffusionCoefficient.cpp.

References GridElement::arr, Df_Ozeke(), Df_Ozeke_E(), and GridElement::size.

Member Data Documentation

Matrix3D<double> DiffusionCoefficient::arr

Definition at line 24 of file DiffusionCoefficient.h.

bool DiffusionCoefficient::Dxx_initialized

flag, indicated that the initialization was passed

Definition at line 27 of file DiffusionCoefficient.h.

DxxParameters_structure DiffusionCoefficient::DxxParameters

Definition at line 30 of file DiffusionCoefficient.h.

string DiffusionCoefficient::type

Type of the diffusion coefficient: Daa, Dpp, Dpa etc... Described in types.h file as an enumeration.

Definition at line 35 of file DiffusionCoefficient.h.

bool DiffusionCoefficient::is_active

flag, if is enabled right now

Definition at line 38 of file DiffusionCoefficient.h.

bool DiffusionCoefficient::useScale

flag, if scale is applyable

Definition at line 41 of file DiffusionCoefficient.h.


The documentation for this class was generated from the following files: