Driver.H

Go to the documentation of this file.

#ifndef __ELMER_FOAM_FSI_H__
#define __ELMER_FOAM_FSI_H__
#ifdef _ELMERFOAMFSI_PARALLEL_
#include "COMM.H"
#endif
#include "Global.H"
#include "Profiler.H"
#include "com.h"

namespace ElmerFoamFSI {
  
  //  namespace ExampleProgram {
  typedef IRAD::Profiler::ProfilerObj ProfilerType;
  typedef std::string                 StackType;
  typedef IRAD::Global::GlobalObj<StackType,int,ProfilerType> GlobalType;
#ifdef _ELMERFOAMFSI_PARALLEL_
  typedef IRAD::Comm::CommunicatorObject CommType;
  typedef IRAD::Global::ParallelGlobalObj<CommType,StackType,int,ProfilerType> PGlobalType;
#endif
  class DriverComLine : public IRAD::Util::ComLineObject
  {
  public:
    DriverComLine()
      : IRAD::Util::ComLineObject()
    {};
    DriverComLine(const char *args[])
      : IRAD::Util::ComLineObject(args)
    {};
    void Initialize(){
      AddOption('h',"help");
      AddOption('d',"debug");
      AddOption('v',"verbosity",1);
      AddOption('o',"output",2,"filename");
      //      AddArgument("input",1);
      AddHelp("help","Prints this long version of help.");
      AddHelp("debug","Turns on debugging output.");
      AddHelp("output","Specifies the name of the output file.");
      AddArgument("inputfile",1);
      std::ostringstream Ostr;
      Ostr << "A configuration file with parameters.";
      // Ostr << "Mode-dependent input: Input <filename> for serial example"
      //      << "\n\t\tprogram, or <number of divisions> for parallel example.";
      AddArgHelp("inputfile",Ostr.str());
      // The following commented string formation is kept around to 
      // illustrate the required tabs and newlines to make the output 
      // look proper:
      //
      //    Ostr << "Use fixed problem size in scalability analysis.  Only makes"
      //         << "\n\t\tsense when scalability mode is enabled.";
      //    Ostr.str("");
      Ostr.str("");
      Ostr << "Example ElmerFoamFSI program.";
      _description.assign(Ostr.str());
    };
  };
    
  typedef DriverComLine ComLineType;
  typedef IRAD::Global::Program<GlobalType,ComLineType> SerialProgramType;
#ifdef _ELMERFOAMFSI_PARALLEL_
  typedef IRAD::Global::Program<PGlobalType,ComLineType> ParallelProgramType;
#endif
  class SerialDriverProgram : public SerialProgramType
  {
  protected:
    std::string output_name;
    std::string input_name;
    int verblevel;
    std::ofstream Ouf;
    std::ifstream Inf;
    int fluidsInitHandle;
    int fluidsRunHandle;
    int fluidsStepHandle;
    int fluidsFinalizeHandle;
    int structuresInitHandle;
    int structuresRunHandle;
    int structuresFinalizeHandle;
    int argc;
    char **argv;
  public:
    SerialDriverProgram() :
      SerialProgramType()
    {};
    SerialDriverProgram(int nargs,char **args) :
      SerialProgramType(nargs,args), argc(nargs), argv(args)
    {
      int nargs_dupe = 2;
      char **args_dupe;
      args_dupe = new char * [3];
      args_dupe[0] = const_cast<char *>("test");
      args_dupe[1] = const_cast<char *>("-com-mpi");
      args_dupe[2] = NULL;
      COM_init(&nargs_dupe,&args_dupe);
    };
    virtual int Initialize()
    {
      int retval = SerialProgramType::Initialize();
      if(!_command_line.GetOption("help").empty()){
        std::ostringstream Ostr;
        Ostr << _command_line.LongUsage() << std::endl;
        StdOut(Ostr.str());
        return(-1);
      }
      if(retval){
        std::ostringstream Ostr;
        Ostr << _command_line.ErrorReport() << std::endl
             << std::endl << _command_line.ShortUsage() << std::endl;
        ErrOut(Ostr.str());
        return(retval);
      }
      if(!_command_line.GetOption("debug").empty()){
        this->SetDebugLevel(2);
        this->SetDebugStream(std::cout);
      }
      // Check if output file is specified
      output_name = _command_line.GetOption("output");
      
      // Set input file to first argument
      std::vector<std::string> args(_command_line.GetArgs());
      input_name = args[0];
      
      // Check the verbosity level
      std::string sverb(_command_line.GetOption("verbosity"));
      if(sverb.empty() || sverb == ".true.")
        verblevel = 1;
      else {
        std::istringstream Vin(sverb);
        Vin >> verblevel;
        if(verblevel < 0)
          verblevel = 1;
      }
     
      //Set the verblevel within IRAD
      SetVerbLevel((char)verblevel);

      // If high verbosity, stick a configuration blurb to stdout.
      if(verblevel > 1){
        std::ostringstream Ostr;
        Ostr << "Configuration:" << std::endl
             << "verbosity           = " << verblevel << std::endl
             << "config file         = " << input_name << std::endl;
        if(!output_name.empty())
          Ostr << "output file         = " << output_name << std::endl;
        Ostr << std::endl;
        StdOut(Ostr.str());
      } 
      
      return(0);
    };
    int VerbLevel() const { return verblevel;};
    virtual ~SerialDriverProgram() {
      if(COM_initialized())
        COM_finalize();
      Report(Ouf);
      if(Ouf){
        Ouf.close();
        SetOutStream(std::cout);
      }
    };
    int DriverRun();
  };
    

#ifdef _ELMERFOAMFSI_PARALLEL_
  class ParallelDriverProgram : public ParallelProgramType
  {
  protected:
    std::string output_name;
    std::string input_name;
    int verblevel;
    std::ofstream Ouf;
    std::ifstream Inf;
    int fluidsInitHandle;
    int fluidsRunHandle;
    int fluidsStepHandle;
    int fluidsFinalizeHandle;
    int structuresInitHandle;
    int structuresRunHandle;
    int structuresFinalizeHandle;
    int argc;
    char **argv;
  public:
    ParallelDriverProgram() :
      ParallelProgramType()
    {verblevel = 0;};
    ParallelDriverProgram(int nargs,char **args) :
      ParallelProgramType(nargs,args), argc(nargs), argv(args)
    {
       // initializing COM with -com-mpi to force calling MPI_init
       int nargs_dupe = 2;
       char **args_dupe;
       args_dupe = new char * [3];
       args_dupe[0] = const_cast<char *>("dummy");
       args_dupe[1] = const_cast<char *>("-com-mpi");
       args_dupe[2] = NULL;
       COM_init(&nargs_dupe,&args_dupe);
       // at this point we should have communicator setup
       //std::cout << "My Rank = " << Rank() << std::endl;
    };
    ParallelDriverProgram(ComLineType &comline,CommType &incomm) 
    {
      this->_command_line.Copy(comline);
      this->Init(_command_line.ProgramName(),incomm);
      verblevel = 0;
    };
    virtual int Initialize()
    {
      int retval = ParallelProgramType::Initialize();
      // Check if the user just entered -h or --help
      if(!_command_line.GetOption("help").empty()){
        std::ostringstream Ostr;
        Ostr << _command_line.LongUsage() << std::endl;
        StdOut(Ostr.str());
        return(-1);
      }
      if(retval){ // then there were errors on the command line
        std::ostringstream Ostr;
        Ostr << _command_line.ErrorReport() << std::endl
             << std::endl << _command_line.ShortUsage() << std::endl;
        ErrOut(Ostr.str());
        return(retval);
      }
      // setting up debuger if needed
      if(!_command_line.GetOption("debug").empty()){
        this->SetDebugLevel(2);
        this->SetDebugStream(std::cout);
      }

      // Everything is OK up to here, so check for an output file.
      output_name = _command_line.GetOption("output");

      // Set input file to first argument
      std::vector<std::string> args(_command_line.GetArgs());
      input_name = args[0];

      // Check the verbosity level
      std::string sverb(_command_line.GetOption("verbosity"));
      if(sverb.empty() || sverb == ".true.")
        verblevel = 1;
      else {
        std::istringstream Vin(sverb);
        Vin >> verblevel;
        if(verblevel < 0)
          verblevel = 1;
      }

      //Set the verblevel within IRAD
      SetVerbLevel((char)verblevel);

      // If high verbosity, stick a configuration blurb to stdout.
      if(verblevel > 1){
        std::ostringstream Ostr;
        Ostr << "*****************************************************"<< std::endl;
        Ostr << "*            Reading the input file                 *"<< std::endl;
        Ostr << "*****************************************************"<< std::endl;
        Ostr << "* Configuration:" << std::endl
             << "* verbosity           = " << verblevel << std::endl;
        if(!input_name.empty())
          Ostr << "* input file          = " << input_name << std::endl;
        if(!output_name.empty())
          Ostr << "* output file         = " << output_name << std::endl;
        Ostr << "*" << std::endl;
        Ostr << "*****************************************************"<< std::endl;
        StdOut(Ostr.str());
      } 

      return(0);
    };
    int VerbLevel() const { return verblevel;};
    virtual ~ParallelDriverProgram() {
      if(COM_initialized())
        COM_finalize();
      if(Ouf){
        Ouf.close();
        SetOutStream(std::cout);
      }
    };
    int DriverRun();
  };
#endif    


  template<typename ProgramType>
  int Driver(int argc,char *argv[])
  {
    ProgramType MyProgram(argc,argv);
    int retval = MyProgram.Initialize();
    if(retval){
      if(retval > 0){ // then there was an error
        MyProgram.ErrOut("Error in Program Initialization.\n");
        return(1);
      }
      else return(0); // no error, but the program should not continue
    }
    if(MyProgram.VerbLevel() > 1)
      MyProgram.StdOut("Calling RUN.\n");
    if(MyProgram.DriverRun()){
      MyProgram.ErrOut("Error in Program RUN method.\n");
      return(1);
    }
    if(MyProgram.VerbLevel() > 1){
      std::ostringstream Ostr;
      MyProgram.Report(Ostr);
      MyProgram.StdOut(Ostr.str());
      MyProgram.StdOut("Calling Finalize.\n");
    }
    if(MyProgram.Finalize()){
      MyProgram.ErrOut("Error in Program Finalization.\n");
      return(1);
    }
    if(MyProgram.VerbLevel() > 1)
      MyProgram.StdOut("All done.\n");
    return(0);
  }


  typedef ElmerFoamFSI::SerialDriverProgram DriverProgramType;
#ifdef _ELMERFOAMFSI_PARALLEL_
  inline double f(double x)
  {
    return (4.0 / (1.0 + x*x));
  }
  typedef ElmerFoamFSI::ParallelDriverProgram PEProgramType;
#endif
  //  };
};
#endif