AVIabstractMain Class Reference
Common functionality for different versions and algorithms.  
More...
#include <AVIabstractMain.h>
List of all members.
Classes | 
| struct   | InputConfig | 
Public Member Functions | 
| virtual void  | runLoop (MeshInit &meshInit, GlobalVec &g, bool createSyncFiles)=0 | 
| void  | run (int argc, const char *argv[]) | 
|   | The main method to call.  
  | 
| void  | verify (const InputConfig &input, const MeshInit &meshInit, const GlobalVec &g) const  | 
Static Public Member Functions | 
| static void  | simulate (AVI *avi, MeshInit &meshInit, GlobalVec &g, LocalVec &l, bool createSyncFiles) | 
|   | Code common to loop body of different versions Performs the updates to avi parameter.  
  | 
Protected Member Functions | 
| virtual const std::string  | getVersion () const =0 | 
|   | version name  
  | 
| virtual void  | initRemaining (const MeshInit &meshInit, const GlobalVec &g)=0 | 
|   | To be implemented by derived classes for some type specific initialization e.g.  
  | 
Static Private Member Functions | 
| static const std::string  | getUsage () | 
| static void  | printUsage () | 
| static InputConfig  | readCmdLine (std::vector< const char * > args) | 
| static MeshInit *  | initMesh (const InputConfig &input) | 
| static void  | initGlobalVec (const MeshInit &meshInit, GlobalVec &g) | 
Detailed Description
Common functionality for different versions and algorithms. 
Member Function Documentation
      
        
          | const std::string AVIabstractMain::getUsage  | 
          ( | 
           | 
           )  | 
           [static, private] | 
        
      
 
 
      
        
          | virtual const std::string AVIabstractMain::getVersion  | 
          ( | 
           | 
           )  | 
           const [protected, pure virtual] | 
        
      
 
 
      
        
          | void AVIabstractMain::initGlobalVec  | 
          ( | 
          const MeshInit &  | 
           meshInit,  | 
        
        
           | 
           | 
          GlobalVec &  | 
           g |   | 
        
        
           | 
          ) | 
           |  |  [static, private] | 
        
      
 
 
      
        
          | virtual void AVIabstractMain::initRemaining  | 
          ( | 
          const MeshInit &  | 
           meshInit,  | 
        
        
           | 
           | 
          const GlobalVec &  | 
           g |   | 
        
        
           | 
          ) | 
           |  |  [protected, pure virtual] | 
        
      
 
To be implemented by derived classes for some type specific initialization e.g. 
unordered needs element adjacency graph while ordered needs a lock per node of the original mesh. 
- Parameters:
 - 
  
  
 
Implemented in AVIorderedSerial, and AVIunordered.
 
 
      
        
          | void AVIabstractMain::printUsage  | 
          ( | 
           | 
           )  | 
           [static, private] | 
        
      
 
 
      
        
          | void AVIabstractMain::run  | 
          ( | 
          int  | 
           argc,  | 
        
        
           | 
           | 
          const char *  | 
           argv[] |   | 
        
        
           | 
          ) | 
           |  |  | 
        
      
 
The main method to call. 
- Parameters:
 - 
  
  
 
 
 
      
        
          | virtual void AVIabstractMain::runLoop  | 
          ( | 
          MeshInit &  | 
           meshInit,  | 
        
        
           | 
           | 
          GlobalVec &  | 
           g,  | 
        
        
           | 
           | 
          bool  | 
           createSyncFiles |   | 
        
        
           | 
          ) | 
           |  |  [pure virtual] | 
        
      
 
 
Code common to loop body of different versions Performs the updates to avi parameter. 
- Parameters:
 - 
  
     | avi  |  | 
     | meshInit  |  | 
     | g  |  | 
     | l  |  | 
     | createSyncFiles  |  | 
  
   
 
 
The documentation for this class was generated from the following file: