DiffusionCoefficientsGroup Class Reference

It has DiffusionCoefficient class as a parent class, so it stores there summation of all the coefficients to use in diffusion. More...

#include <DiffusionCoefficient.h>

Inheritance diagram for DiffusionCoefficientsGroup:

Inheritance graph
[legend]
Collaboration diagram for DiffusionCoefficientsGroup:

Collaboration graph
[legend]

List of all members.

Public Member Functions

bool ActivateAndScale (double time, double Kp)
 Function activate (enable/disable) diffusion coefficients according time events and scale diffusion coefficients. It would be cool to call it "Actualize", but unfortunatelly it would be too complicated.
 DiffusionCoefficientsGroup (string type, Grid &grid)
 Constructor. It save passed in type and grid to this->type and this->grid. "this->" in C++ means... whatever, it means local.
 DiffusionCoefficientsGroup (string type, int L_size, int pc_size, int alpha_size)
 Constructor. That constructor save type and runs constructor of the parent class - DiffusionCoefficient.
 DiffusionCoefficientsGroup (string type, Grid &grid, DiffusionCoefficientParamStructureList DxxParamStructureList)
 Constructor. Save the type, the grid and get (load or calculate) all diffusion coefficients with the type from the DxxParamStructureList.
void Get (DiffusionCoefficientParamStructureList DxxParamStructureList)
 Get the diffusion coefficients matrix values (load or calculate.
void Get (DiffusionCoefficientParamStructureList DxxParamStructureList, string type)
 Get the diffusion coefficients matrix values (load or calculate.
void Get (Grid &grid, DiffusionCoefficientParamStructureList DxxParamStructureList)
 Get the diffusion coefficients matrix values (load or calculate.
void Get (Grid &grid, DiffusionCoefficientParamStructureList DxxParamStructureList, string type)
 Get the diffusion coefficients matrix values (load or calculate.
DiffusionCoefficientsGroupoperator= (double val)
 Operator = val.
DiffusionCoefficientsGroupoperator= (const Matrix3D< double > &M)
 Operator = Matrix.
DiffusionCoefficientsGroupoperator= (const DiffusionCoefficient &Dxx)
 Operator = Dxx.

Public Attributes

vector< DiffusionCoefficientDxxList
 List of diffusion coefficients in that group. Actually, it's a list of waves used in the diffusion coefficient that this group represent.


Detailed Description

It has DiffusionCoefficient class as a parent class, so it stores there summation of all the coefficients to use in diffusion.

So, it is DiffusionCoefficient in common cense.

Todo:
change DiffusionCoefficientGroup name to the DiffusionCoefficient name and DiffusionCoefficient name to something else.
Holds list of instances of DiffusionCoefficient class of same type (like Daa, Dpp, etc), but produced by different waves (Daa_chorus, Daa_EMIC, etc).

Definition at line 131 of file DiffusionCoefficient.h.


Constructor & Destructor Documentation

DiffusionCoefficientsGroup::DiffusionCoefficientsGroup ( string  type,
Grid grid 
)

Constructor. It save passed in type and grid to this->type and this->grid. "this->" in C++ means... whatever, it means local.

DiffusionCoefficientsGroup constructor Didn't I mension, that the name of the class should be changed?

Definition at line 430 of file DiffusionCoefficient.cpp.

DiffusionCoefficientsGroup::DiffusionCoefficientsGroup ( string  type,
int  L_size,
int  pc_size,
int  alpha_size 
)

Constructor. That constructor save type and runs constructor of the parent class - DiffusionCoefficient.

DiffusionCoefficientsGroup constructor.

Parameters:
type - Type. Of the parent diffusion coefficient.
L_size - L size
pc_size - pc size
alpha_size - alpha size

Definition at line 439 of file DiffusionCoefficient.cpp.

DiffusionCoefficientsGroup::DiffusionCoefficientsGroup ( string  type,
Grid grid,
DiffusionCoefficientParamStructureList  DxxParamStructureList 
)

Constructor. Save the type, the grid and get (load or calculate) all diffusion coefficients with the type from the DxxParamStructureList.

DiffusionCoefficientsGroup constructor.

Parameters:
type - diffusion coefficient type.
&grid - grid
DxxParamStructureList - damn, that's the list (vector) of diffusion coefficients param structure. What the point to duble all variables names???

Definition at line 448 of file DiffusionCoefficient.cpp.

References Get().

Here is the call graph for this function:


Member Function Documentation

bool DiffusionCoefficientsGroup::ActivateAndScale ( double  time,
double  Kp 
)

Function activate (enable/disable) diffusion coefficients according time events and scale diffusion coefficients. It would be cool to call it "Actualize", but unfortunatelly it would be too complicated.

Activation (enabling/disabling) and scaling of the diffusion coefficients in one group.

Parameters:
time - time
Kp - Kp
It loops thrue the list of the diffusion coefficients, enable which needs to be enabled, disable, which needs to be disabled and scale all enabled

Definition at line 493 of file DiffusionCoefficient.cpp.

References Matrix3D< double >::change_ind, DiffusionCoefficient::Dxx_parameters, DxxList, Output::echo(), DiffusionCoefficient::is_active, Matrix3D< double >::name, DiffusionCoefficientParamStructure::time_start, and DiffusionCoefficient::useScale.

Referenced by main().

Here is the call graph for this function:

Here is the caller graph for this function:

void DiffusionCoefficientsGroup::Get ( Grid grid,
DiffusionCoefficientParamStructureList  DxxParamStructureList,
string  type 
)

Get the diffusion coefficients matrix values (load or calculate.

Calculating all diffusion coefficients in the class.

Type and grid are taken from the parameters. It makes list of the diffusion coefficients with the same type (Daa_chorus, Daa_hiss etc). Each time new diffusion coefficient is pushed in the list, it's constructor is runned and construct it. Isn't easyer just to look to the 2 lines of the code, then read all these multiple lines of unclear comments?

Definition at line 472 of file DiffusionCoefficient.cpp.

References Matrix3D< double >::change_ind, DiffusionCoefficient::DiffusionCoefficient(), DxxList, and Matrix3D< double >::name.

Here is the call graph for this function:

void DiffusionCoefficientsGroup::Get ( Grid grid,
DiffusionCoefficientParamStructureList  DxxParamStructureList 
)

Get the diffusion coefficients matrix values (load or calculate.

Calculation of all diffusion coefficients in the group Taking grid from the parameters and type from the class And pass everything to the calculating function.

Definition at line 461 of file DiffusionCoefficient.cpp.

References Get(), and DiffusionCoefficient::type.

Here is the call graph for this function:

void DiffusionCoefficientsGroup::Get ( DiffusionCoefficientParamStructureList  DxxParamStructureList,
string  type 
)

Get the diffusion coefficients matrix values (load or calculate.

void DiffusionCoefficientsGroup::Get ( DiffusionCoefficientParamStructureList  DxxParamStructureList  ) 

Get the diffusion coefficients matrix values (load or calculate.

Referenced by DiffusionCoefficientsGroup(), Get(), and main().

Here is the caller graph for this function:

DiffusionCoefficientsGroup & DiffusionCoefficientsGroup::operator= ( const DiffusionCoefficient Dxx  ) 

Operator = Dxx.

operator DxxGroup = val Makes Dxx = Matrix for parent class

Definition at line 600 of file DiffusionCoefficient.cpp.

References operator=().

Here is the call graph for this function:

DiffusionCoefficientsGroup & DiffusionCoefficientsGroup::operator= ( const Matrix3D< double > &  M  ) 

Operator = Matrix.

operator DxxGroup = val Makes Dxx = Matrix for parent class

Reimplemented from DiffusionCoefficient.

Definition at line 592 of file DiffusionCoefficient.cpp.

References operator=().

Here is the call graph for this function:

DiffusionCoefficientsGroup & DiffusionCoefficientsGroup::operator= ( double  val  ) 

Operator = val.

operator DxxGroup = val Makes Dxx = val for parent class

Reimplemented from DiffusionCoefficient.

Definition at line 583 of file DiffusionCoefficient.cpp.

Referenced by operator=().

Here is the caller graph for this function:


Member Data Documentation

List of diffusion coefficients in that group. Actually, it's a list of waves used in the diffusion coefficient that this group represent.

Definition at line 139 of file DiffusionCoefficient.h.

Referenced by ActivateAndScale(), Get(), and main().


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

Generated on Thu May 27 11:53:19 2010 for VERB_CODE_2.0 by  doxygen 1.5.9