Main Page | Modules | Data Structures | File List | Data Fields | Globals | Related Pages

Vpee class

This class provides some functionality for error esimation in parallel. More...


Files

file  vpee.h
 Contains declarations for class Vpee.


Data Structures

struct  sVpee
 Contains public data members for Vpee class/module. More...


Typedefs

typedef sVpee Vpee
 Declaration of the Vpee class as the Vpee structure.


Functions

VpeeVpee_ctor (Gem *gm, int localPartID, int killFlag, double killParam)
 Construct the Vpee object.

int Vpee_ctor2 (Vpee *thee, Gem *gm, int localPartID, int killFlag, double killParam)
 FORTRAN stub to construct the Vpee object.

void Vpee_dtor (Vpee **thee)
 Object destructor.

void Vpee_dtor2 (Vpee *thee)
 FORTRAN stub object destructor.

int Vpee_markRefine (Vpee *thee, AM *am, int level, int akey, int rcol, double etol, int bkey)
 Mark simplices for refinement based on attenuated error estimates.

int Vpee_numSS (Vpee *thee)
 Returns the number of simplices in the local partition.


Detailed Description

This class provides some functionality for error esimation in parallel.

This class provides some functionality for error esimation in parallel. The purpose is to modulate the error returned by some external error estimator according to the partitioning of the mesh. For example, the Bank/Holst parallel refinement routine essentially reduces the error outside the ``local" partition to zero. However, this leads to the need for a few final overlapping Schwarz solves to smooth out the errors near partition boundaries. Supposedly, if the region in which we allow error-based refinement includes the ``local" partition and an external buffer zone approximately equal in size to the local region, then the solution will asymptotically approach the solution obtained via more typical methods. This is essentially a more flexible parallel implementation of MC's AM_markRefine.


Function Documentation

Vpee* Vpee_ctor Gem *  gm,
int  localPartID,
int  killFlag,
double  killParam
 

Construct the Vpee object.

Author:
Nathan Baker
Returns:
Newly constructed Vpee object
Parameters:
localPartID  FEtk geometry manager object
killFlag  ID of the local partition (focus of refinement)
killParam  A flag to indicate how error estimates are to be attenuated outside the local partition:
  • 0: no attenuation
  • 1: all error outside the local partition set to zero
  • 2: all error is set to zero outside a sphere of radius (killParam*partRadius), where partRadius is the radius of the sphere circumscribing the local partition
  • 3: all error is set to zero except for the local partition and its immediate neighbors
    See also:
    killFlag for usage

int Vpee_ctor2 Vpee thee,
Gem *  gm,
int  localPartID,
int  killFlag,
double  killParam
 

FORTRAN stub to construct the Vpee object.

Author:
Nathan Baker
Returns:
1 if successful, 0 otherwise
Parameters:
gm  The Vpee object
localPartID  FEtk geometry manager object
killFlag  ID of the local partition (focus of refinement)
killParam  A flag to indicate how error estimates are to be attenuated outside the local partition:
  • 0: no attenuation
  • 1: all error outside the local partition set to zero
  • 2: all error is set to zero outside a sphere of radius (killParam*partRadius), where partRadius is the radius of the sphere circumscribing the local partition
  • 3: all error is set to zero except for the local partition and its immediate neighbors
    See also:
    killFlag for usage

void Vpee_dtor Vpee **  thee  ) 
 

Object destructor.

Author:
Nathan Baker
Parameters:
thee  Pointer to memory location of the Vpee object

void Vpee_dtor2 Vpee thee  ) 
 

FORTRAN stub object destructor.

Author:
Nathan Baker
Parameters:
thee  Pointer to object to be destroyed

int Vpee_markRefine Vpee thee,
AM *  am,
int  level,
int  akey,
int  rcol,
double  etol,
int  bkey
 

Mark simplices for refinement based on attenuated error estimates.

A wrapper/reimplementation of AM_markRefine that allows for more flexible attenuation of error-based markings outside the local partition. The error in each simplex is modified by the method (see killFlag) specified in the Vpee constructor. This allows the user to confine refinement to an arbitrary area around the local partition.

Author:
Nathan Baker and Mike Holst
Note:
This routine borrows very heavily from FEtk routines by Mike Holst.
Returns:
The number of simplices marked for refinement.

Bug:
This function is no longer up-to-date with FEtk and may not function properly
Parameters:
am  The Vpee object
level  The FEtk algebra manager currently used to solve the PB
akey  The current level of the multigrid hierarchy
rcol  The marking method:
  • -1: Reset markings --> killFlag has no effect.
  • 0: Uniform.
  • 1: User defined (geometry-based).
  • >1: A numerical estimate for the error has already been set in am and should be attenuated according to killFlag and used, in conjunction with etol, to mark simplices for refinement.
etol  The ID of the main parition on which to mark (or -1 if all partitions should be marked). NOte that we shouldhave (rcol == thee->localPartID) for (thee->killFlag == 2 or 3)
bkey  The error tolerance criterion for marking How the error tolerance is interpreted:
  • 0: Simplex marked if error > etol.
  • 1: Simplex marked if error > sqrt(etol^2/L) where L$ is the number of simplices

int Vpee_numSS Vpee thee  ) 
 

Returns the number of simplices in the local partition.

Author:
Nathan Baker
Returns:
Number of simplices in the local partition
Parameters:
thee  The Vpee object


Generated on Tue Dec 6 10:05:59 2005 for APBS by doxygen 1.3.5