MOOSE - Multiscale Object Oriented Simulation Environment
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros
VoxelJunction Class Reference

#include <VoxelJunction.h>

+ Collaboration diagram for VoxelJunction:

Public Member Functions

bool operator< (const VoxelJunction &other) const
 
 VoxelJunction (unsigned int f, unsigned int s, double d=1.0)
 
 VoxelJunction ()
 

Public Attributes

double diffScale
 
unsigned int first
 
double firstVol
 MeshIndex for second compartment. More...
 
unsigned int second
 MeshIndex for first compartment. More...
 
double secondVol
 

Detailed Description

This class specifies a single junction between abutting voxels. All it has are the respective meshIndices (not spatialIndices) of the abutting voxels, and a scale factor for diffusion between them.

Definition at line 18 of file VoxelJunction.h.

Constructor & Destructor Documentation

VoxelJunction::VoxelJunction ( unsigned int  f,
unsigned int  s,
double  d = 1.0 
)
inline

Definition at line 21 of file VoxelJunction.h.

22  : first( f ), second( s ),
23  firstVol( 0 ), secondVol( 0 ),
24  diffScale( d )
25  {;}
double diffScale
Definition: VoxelJunction.h:44
unsigned int second
MeshIndex for first compartment.
Definition: VoxelJunction.h:41
double secondVol
Definition: VoxelJunction.h:43
double firstVol
MeshIndex for second compartment.
Definition: VoxelJunction.h:42
unsigned int first
Definition: VoxelJunction.h:40
VoxelJunction::VoxelJunction ( )
inline

Definition at line 26 of file VoxelJunction.h.

27  : first( ~0 ), second( ~0 ), firstVol( 0 ), secondVol( 0 ),
28  diffScale( 1.0 )
29  {;}
double diffScale
Definition: VoxelJunction.h:44
unsigned int second
MeshIndex for first compartment.
Definition: VoxelJunction.h:41
double secondVol
Definition: VoxelJunction.h:43
double firstVol
MeshIndex for second compartment.
Definition: VoxelJunction.h:42
unsigned int first
Definition: VoxelJunction.h:40

Member Function Documentation

bool VoxelJunction::operator< ( const VoxelJunction other) const
inline

Definition at line 32 of file VoxelJunction.h.

References first, and second.

33  {
34  if ( first < other.first ) return 1;
35  if ( first > other.first ) return 0;
36  if ( second < other.second ) return 1;
37  return 0;
38  }
unsigned int second
MeshIndex for first compartment.
Definition: VoxelJunction.h:41
unsigned int first
Definition: VoxelJunction.h:40

Member Data Documentation

double VoxelJunction::diffScale

Definition at line 44 of file VoxelJunction.h.

Referenced by Dsolve::getDiffScale(), and Dsolve::setDiffScale().

unsigned int VoxelJunction::first

Definition at line 40 of file VoxelJunction.h.

Referenced by operator<().

double VoxelJunction::firstVol

MeshIndex for second compartment.

Definition at line 42 of file VoxelJunction.h.

Referenced by Dsolve::getDiffVol1(), and Dsolve::setDiffVol1().

unsigned int VoxelJunction::second

MeshIndex for first compartment.

Definition at line 41 of file VoxelJunction.h.

Referenced by operator<().

double VoxelJunction::secondVol

Definition at line 43 of file VoxelJunction.h.

Referenced by Dsolve::getDiffVol2(), and Dsolve::setDiffVol2().


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