BoundaryCondition Class Reference

#include <BoundaryConditions.h>

Inheritance diagram for BoundaryCondition:

Inheritance graph
[legend]
Collaboration diagram for BoundaryCondition:

Collaboration graph
[legend]

List of all members.

Public Member Functions

 BoundaryCondition ()
 Default constructor - do nothing.
 BoundaryCondition (int time_size, int size_two, int size_three, ParamStructure::BoundaryCondition parameters)
 Constructor.
void Initialize (ParamStructure::BoundaryCondition parameters)
 Boundary condition initialization.
BoundaryConditionoperator= (double val)
 Makes boundary value equal to val.
BoundaryConditionoperator= (Matrix3D< double > M)
 Make boundary value equal to Matrix M.
BoundaryCondition operator* (double val)
 Multiply boundary to a value val;.
void MakeBoundaryCondition (Matrix2D< double > psd2DSlice, Matrix2D< double > gridElement1, Matrix2D< double > gridElement2)
 Making boundary conditions.
void LoadBoundaryCondition (Matrix2D< double > gridElement1, Matrix2D< double > gridElement2)
 Load boundary conditions from file.
void Update (int it, Matrix2D< double > PSD_2D_Slice)
 Update boundary condition for current time step.

Public Attributes

ParamStructure::BoundaryCondition BC_parameters
string calculationType
 Type: constant function/constant derivative.
string initialType
 Initial type: how to set up boundary conditions. (Like read from a file, etc).
double value
 Base value at the boundary.
string filename
 File name for loading of additional sources/losses at the boundary.


Detailed Description

Definition at line 21 of file BoundaryConditions.h.


Constructor & Destructor Documentation

BoundaryCondition::BoundaryCondition (  )  [inline]

Default constructor - do nothing.

Definition at line 39 of file BoundaryConditions.h.

BoundaryCondition::BoundaryCondition ( int  time_size,
int  size_two,
int  size_three,
ParamStructure::BoundaryCondition  parameters 
)

Constructor.

Run constructor of the parent matrix class.

Definition at line 11 of file BoundaryConditions.cpp.

References Initialize().

Here is the call graph for this function:


Member Function Documentation

void BoundaryCondition::Initialize ( ParamStructure::BoundaryCondition  parameters  ) 

Boundary condition initialization.

Saving type of BC (on value/derivative etc), readed from parameters file, to the class variable "calculationType". Saving value on the BC, readed from file, to the class variable "value".

Parameters:
parameters - boundary condition parameters structure

Definition at line 24 of file BoundaryConditions.cpp.

References BC_parameters, calculationType, ParamStructure::BoundaryCondition::filename, filename, initialType, ParamStructure::BoundaryCondition::type, ParamStructure::BoundaryCondition::value, and value.

Referenced by BoundaryCondition().

Here is the caller graph for this function:

void BoundaryCondition::LoadBoundaryCondition ( Matrix2D< double >  gridElement1,
Matrix2D< double >  gridElement2 
)

Load boundary conditions from file.

Here we actually fill-out 2D array of boundary conditions. (in general, 3D grid, case)

Parameters:
gridElement1 - one side of the grid
gridElement2 - second side of the grid

Definition at line 118 of file BoundaryConditions.cpp.

References Output::echo(), err, filename, initialType, Matrix3D< double >::size_x, Matrix3D< double >::size_y, and Matrix3D< double >::size_z.

Here is the call graph for this function:

void BoundaryCondition::MakeBoundaryCondition ( Matrix2D< double >  psd2DSlice,
Matrix2D< double >  gridElement1,
Matrix2D< double >  gridElement2 
)

Making boundary conditions.

Here we actually fill-out 2D array of boundary conditions. (in general, 3D grid case)

Parameters:
psd2DSlice - 2D array, slice of PSD on a boundary
gridElement1 - one side of the grid
gridElement2 - second side of the grid

Definition at line 78 of file BoundaryConditions.cpp.

References calculationType, initialType, Matrix3D< double >::max(), Matrix3D< double >::size_x, Matrix3D< double >::size_y, Matrix3D< double >::size_z, and value.

Referenced by main().

Here is the call graph for this function:

Here is the caller graph for this function:

BoundaryCondition BoundaryCondition::operator* ( double  val  ) 

Multiply boundary to a value val;.

Parameters:
val - value val.

Reimplemented from Matrix3D< double >.

Definition at line 214 of file BoundaryConditions.cpp.

References Matrix3D< T >::Matrix3D().

Here is the call graph for this function:

BoundaryCondition & BoundaryCondition::operator= ( Matrix3D< double >  M  ) 

Make boundary value equal to Matrix M.

Parameters:
M - matrix M

Definition at line 204 of file BoundaryConditions.cpp.

References operator=().

Here is the call graph for this function:

BoundaryCondition & BoundaryCondition::operator= ( double  val  ) 

Makes boundary value equal to val.

Parameters:
val - value val;

Reimplemented from Matrix3D< double >.

Definition at line 193 of file BoundaryConditions.cpp.

Referenced by operator=().

Here is the caller graph for this function:

void BoundaryCondition::Update ( int  iteration,
Matrix2D< double >  PSD_2D_Slice 
)

Update boundary condition for current time step.

Parameters:
iteration - iteration number
PSD_2D_Slice - 2d slice of PSD for that BC

Definition at line 171 of file BoundaryConditions.cpp.

References Output::echo(), initialType, Matrix2D< T >::name, Matrix3D< double >::size_y, and Matrix3D< double >::size_z.

Referenced by main().

Here is the call graph for this function:

Here is the caller graph for this function:


Member Data Documentation

Definition at line 26 of file BoundaryConditions.h.

Referenced by Initialize().

Type: constant function/constant derivative.

Definition at line 29 of file BoundaryConditions.h.

Referenced by Initialize(), main(), and MakeBoundaryCondition().

File name for loading of additional sources/losses at the boundary.

Definition at line 35 of file BoundaryConditions.h.

Referenced by Initialize(), and LoadBoundaryCondition().

Initial type: how to set up boundary conditions. (Like read from a file, etc).

Definition at line 31 of file BoundaryConditions.h.

Referenced by Initialize(), LoadBoundaryCondition(), MakeBoundaryCondition(), PSD::PSD(), and Update().

Base value at the boundary.

Definition at line 33 of file BoundaryConditions.h.

Referenced by Initialize(), and MakeBoundaryCondition().


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