simulator.diffusionSolver.multigrid.MultigridSolute Class Reference

Implements static utility functions for used in multigrid method. More...

Public Member Functions
	MultigridSolute (SoluteGrid aSolute, MultigridSolute relDiff, MultigridSolute bLayer, double sBulk)
	Create a Multigrid solute for each solute being processed by a solver. More...
	MultigridSolute (SoluteGrid aSolute, String gridName)
	Constructor used for biomass, bLayer and relative diffusivity grids. More...
void	initLoop (int order)
	Beginning of each nested loop. More...
void	downward (int order, int outer)
void	downward1 (int order, int outer)
void	downward2 (int order, int outer)
void	upward (int order)
boolean	breakVCycle (int order, int v)
double	relax (int order)
void	truncateConcToZero (int order)
void	resetMultigridCopies (double value)
void	resetMultigridCopies ()
void	resetFinest (double value)
void	resetReaction (int order)
void	setSoluteGridToBulk (int order)
SoluteGrid	getFinest ()
SoluteGrid	getGrid ()
void	setFinest (SoluteGrid aGrid)
void	restrictToCoarsest ()
void	setReferenceSide ()
void	refreshDiffBoundaries (int order)
void	applyComputation ()
void	readSoluteGrid ()
void	readBulk ()

Public Attributes
String	soluteName
SoluteGrid	realGrid
SoluteGrid[]	_conc
SoluteGrid[]	_reac
SoluteGrid[]	_diffReac
double	truncationError

Static Public Attributes
static final double	BLTHRESH = 0.1

Protected Attributes
double	_referenceSystemSide
double	_diffusivity
Domain	_domain
double	sBulkMax
double	sBulk
SoluteGrid[]	_relDiff
SoluteGrid[]	_bLayer
SoluteGrid[]	_rhs
SoluteGrid[]	_itau

Detailed Description

Implements static utility functions for used in multigrid method.

Implements static utility functions for used in multigrid method.

Author

João Xavier (xavie.nosp@m.rj@m.nosp@m.skcc..nosp@m.org), Memorial Sloan-Kettering Cancer Center (NY, USA)

Constructor & Destructor Documentation

simulator.diffusionSolver.multigrid.MultigridSolute.MultigridSolute	(	SoluteGrid	aSolute,
		MultigridSolute	relDiff,
		MultigridSolute	bLayer,
		double	sBulk
	)

Create a Multigrid solute for each solute being processed by a solver.

Create a Multigrid solute for each solute being processed by a solver

Parameters

aSolute	The solute grid containing the concentrations of this solute
relDiff	Diffusivity grid for this solute
bLayer	Boundary layer
sBulk	Max level of this solute in the bulk

simulator.diffusionSolver.multigrid.MultigridSolute.MultigridSolute	(	SoluteGrid	aSolute,
		String	gridName
	)

Constructor used for biomass, bLayer and relative diffusivity grids.

Constructor used for biomass, bLayer and relative diffusivity grids

Parameters

aSolute	SoluteGrid to be used by the Multigrid
gridName	Name of the solute grid

Member Function Documentation

void simulator.diffusionSolver.multigrid.MultigridSolute.applyComputation

(

)

boolean simulator.diffusionSolver.multigrid.MultigridSolute.breakVCycle	(	int	order,
		int	v
	)

void simulator.diffusionSolver.multigrid.MultigridSolute.downward	(	int	order,
		int	outer
	)

void simulator.diffusionSolver.multigrid.MultigridSolute.downward1	(	int	order,
		int	outer
	)

void simulator.diffusionSolver.multigrid.MultigridSolute.downward2	(	int	order,
		int	outer
	)

SoluteGrid simulator.diffusionSolver.multigrid.MultigridSolute.getFinest

(

)

SoluteGrid simulator.diffusionSolver.multigrid.MultigridSolute.getGrid

(

)

void simulator.diffusionSolver.multigrid.MultigridSolute.initLoop

(

int

order

)

Beginning of each nested loop.

Beginning of each nested loop

Parameters

order

Integer noting the order of process

void simulator.diffusionSolver.multigrid.MultigridSolute.readBulk

(

)

Update bulk concentration

void simulator.diffusionSolver.multigrid.MultigridSolute.readSoluteGrid

(

)

void simulator.diffusionSolver.multigrid.MultigridSolute.refreshDiffBoundaries

(

int

order

)

double simulator.diffusionSolver.multigrid.MultigridSolute.relax

(

int

order

)

void simulator.diffusionSolver.multigrid.MultigridSolute.resetFinest

(

double

value

)

Parameters

value

void simulator.diffusionSolver.multigrid.MultigridSolute.resetMultigridCopies

(

double

value

)

void simulator.diffusionSolver.multigrid.MultigridSolute.resetMultigridCopies

(

)

void simulator.diffusionSolver.multigrid.MultigridSolute.resetReaction

(

int

order

)

void simulator.diffusionSolver.multigrid.MultigridSolute.restrictToCoarsest

(

)

void simulator.diffusionSolver.multigrid.MultigridSolute.setFinest

(

SoluteGrid

aGrid

)

void simulator.diffusionSolver.multigrid.MultigridSolute.setReferenceSide

(

)

Determine order of the finest grid

void simulator.diffusionSolver.multigrid.MultigridSolute.setSoluteGridToBulk

(

int

order

)

Set all grids elements to the value defined for Bulk. For elements located in the convective part (i.e. outside the BLayer, we take the value defined in the BulkBoundary Class)

void simulator.diffusionSolver.multigrid.MultigridSolute.truncateConcToZero

(

int

order

)

void simulator.diffusionSolver.multigrid.MultigridSolute.upward

(

int

order

)

Member Data Documentation

SoluteGrid [] simulator.diffusionSolver.multigrid.MultigridSolute._bLayer

protected

SoluteGrid [] simulator.diffusionSolver.multigrid.MultigridSolute._conc

Concentration of this solute

SoluteGrid [] simulator.diffusionSolver.multigrid.MultigridSolute._diffReac

double simulator.diffusionSolver.multigrid.MultigridSolute._diffusivity

protected

Domain simulator.diffusionSolver.multigrid.MultigridSolute._domain

protected

The computational domain that this solute grid is associated with

SoluteGrid [] simulator.diffusionSolver.multigrid.MultigridSolute._itau

protected

SoluteGrid [] simulator.diffusionSolver.multigrid.MultigridSolute._reac

double simulator.diffusionSolver.multigrid.MultigridSolute._referenceSystemSide

protected

SoluteGrid [] simulator.diffusionSolver.multigrid.MultigridSolute._relDiff

protected

SoluteGrid [] simulator.diffusionSolver.multigrid.MultigridSolute._rhs

protected

final double simulator.diffusionSolver.multigrid.MultigridSolute.BLTHRESH = 0.1

static

SoluteGrid simulator.diffusionSolver.multigrid.MultigridSolute.realGrid

The simulation solute grid containing the concentrations of this solute

double simulator.diffusionSolver.multigrid.MultigridSolute.sBulk

protected

Solute level in the connected bulk

double simulator.diffusionSolver.multigrid.MultigridSolute.sBulkMax

protected

Maximum solute level in the connected bulk

String simulator.diffusionSolver.multigrid.MultigridSolute.soluteName

Name of the solute in this multigrid

double simulator.diffusionSolver.multigrid.MultigridSolute.truncationError

---

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

• /home/kieran/Dropbox/workspace/iDynoMiCS/src/simulator/diffusionSolver/multigrid/MultigridSolute.java