EnsembleSimulation Class Reference

Class describing ensemble simulations. More...

#include <ensemble_simulations.h>

Inheritance diagram for EnsembleSimulation:

Public Member Functions
	EnsembleSimulation ()
	~EnsembleSimulation ()
int	define (int, int)
int	ReadInputs ()
int	Initialize ()
int	InitialSolution ()
int	InitializeBoundaries ()
int	InitializeImmersedBoundaries ()
int	InitializePhysics ()
int	InitializePhysicsData ()
int	InitializeSolvers ()
int	Solve ()
void	WriteErrors (double a_wt_solver, double a_wt_total)
bool	isDefined () const
int	mpiCommDup ()
void	usePetscTS (PetscBool a_flag)
int	SolvePETSc ()
Public Member Functions inherited from Simulation
	Simulation ()
virtual	~Simulation ()
virtual int	InitializationWrapup ()

Protected Attributes
bool	m_is_defined
int	m_nsims
int	m_rank
int	m_nproc
std::vector< SimulationObject >	m_sims

Detailed Description

Class describing ensemble simulations.

Class describing ensemble simulations This class contains all data and functions needed to run ensemble simulations, i.e., multiple simulations of the same physics with the same numerical methods but on multiple grids.

This class contains all data and functions needed to run ensemble simulations, i.e., multiple simulations of the same physics with the same numerical methods but on multiple grids.

Definition at line 30 of file ensemble_simulations.h.

Constructor & Destructor Documentation

EnsembleSimulation()

EnsembleSimulation ( )

inline

Constructor

Definition at line 35 of file ensemble_simulations.h.

    {
      m_is_defined = false;
      m_sims.clear();
      m_nsims = 0;
      m_nproc = -1;
      m_rank = -1;
    }

~EnsembleSimulation()

~EnsembleSimulation ( )

inline

Destructor

Definition at line 45 of file ensemble_simulations.h.

    {
      int err = Cleanup((void*) m_sims.data(), m_nsims);
      if (err) {
        printf( "Error: CleanUp() returned with status %d on process %d.\n",
                err, m_rank );
      }
      m_sims.clear();
    }

Member Function Documentation

define()

int define ( int  a_rank, int  a_nproc  )

virtual

Define this object

Define the ensemble simulation object: This function also reads sparse grids inputs from the file simulation.inp. Rank 0 reads in the inputs and broadcasts them to all the processors.

The format of solver.inp is as follows:

begin
    <keyword>   <value>
    <keyword>   <value>
    ...
    <keyword>   <value>
end

where the list of keywords and their type are:

Keyword name	Type	Variable	Default value –
nsims	int	EnsembleSimulation::m_nsims	-1

Parameters

a_rank	MPI rank of this process
a_nproc	Total number of MPI ranks

Implements Simulation.

Definition at line 28 of file EnsembleSimulationsDefine.cpp.

{
  if (m_is_defined) {
    fprintf(stderr,"Error: object already defined on rank %d.\n", a_rank);
    return 1;
  }

  m_rank = a_rank;
  m_nproc = a_nproc;

  /* default value */
  m_nsims = -1;

  if (!m_rank) {

    FILE *in;
    in = fopen(_ENSEMBLE_SIM_INP_FNAME_,"r");

    if (!in) {
      fprintf(stderr, "Error in EnsembleSimulations::Define() - %s file not found.\n",
              _ENSEMBLE_SIM_INP_FNAME_);
    } else {

      int ferr;
      char word[_MAX_STRING_SIZE_];
      ferr = fscanf(in,"%s", word); if (ferr != 1) return(1);

      if (std::string(word) == "begin") {

        while (std::string(word) != "end") {

          ferr = fscanf(in,"%s",word); if (ferr != 1) return(1);

          if (std::string(word) == "nsims") {
            ferr = fscanf(in,"%d",&m_nsims); if (ferr != 1) return(1);
          } else if (std::string(word) != "end") {
            char useless[_MAX_STRING_SIZE_];
            ferr = fscanf(in,"%s",useless);
            printf("Warning: keyword %s in file \"%s\" with value %s not recognized or extraneous. Ignoring.\n",
                    _ENSEMBLE_SIM_INP_FNAME_, word, useless );
          }

          if (ferr != 1) return(1);
        }

      } else {
        fprintf(stderr,"Error: Illegal format in file \"%s\". Word read is: %s\n",
                _ENSEMBLE_SIM_INP_FNAME_, word);
        return 1;
      }

      fclose(in);

    }

    if (m_nsims < 1) {
      fprintf(stderr,"Error in InitializeSimulation(): invalid value for nsims (%d)!\n", m_nsims);
      return 1;
    }

    printf("Number of simulation domains: %d\n", m_nsims);

  }

#ifndef serial
  MPI_Bcast(&m_nsims,1,MPI_INT,0,MPI_COMM_WORLD);
#endif

  if (m_nsims < 0) {
    return 1;
  }

  m_sims.resize(m_nsims);
  for (int ns = 0; ns < m_nsims; ns++) {
    m_sims[ns].solver.my_idx = ns;
    m_sims[ns].solver.nsims = m_nsims;
    m_sims[ns].mpi.rank = m_rank;
    m_sims[ns].mpi.nproc = m_nproc;
  }

  if (!m_rank) {
    printf("Allocated simulation object(s).\n");
  }

  m_is_defined = true;
  return 0;
}

ReadInputs()

int ReadInputs ( )

inlinevirtual

Read solver inputs

Implements Simulation.

Definition at line 59 of file ensemble_simulations.h.

    {
      int retval = ::ReadInputs(  (void*) m_sims.data(),
                                  m_nsims, 
                                  m_rank );
      ::WriteInputs( (void*) m_sims.data(),
                     m_nsims, 
                     m_rank );
      return retval;
    }

Initialize()

int Initialize ( )

inlinevirtual

Initialize the simulations

Implements Simulation.

Definition at line 71 of file ensemble_simulations.h.

    {
      int retval = ::Initialize(  (void*) m_sims.data(),
                                  m_nsims );
      return retval;
    }

InitialSolution()

int InitialSolution ( )

inlinevirtual

Read initial solution for each simulation

Implements Simulation.

Definition at line 79 of file ensemble_simulations.h.

    {
      int retval = ::InitialSolution( (void*) m_sims.data(),
                                      m_nsims );
      return retval;
    }

InitializeBoundaries()

int InitializeBoundaries ( )

inlinevirtual

Initialize the boundary conditions of the simulations

Implements Simulation.

Definition at line 87 of file ensemble_simulations.h.

    {
      int retval = ::InitializeBoundaries(  (void*) m_sims.data(),
                                            m_nsims );
      return retval;
    }

InitializeImmersedBoundaries()

int InitializeImmersedBoundaries ( )

inlinevirtual

Initialize the immersed boundary conditions of the simulations

Implements Simulation.

Definition at line 95 of file ensemble_simulations.h.

    {
      int retval = ::InitializeImmersedBoundaries(  (void*) m_sims.data(),
                                                    m_nsims );
      return retval;
    }

InitializePhysics()

int InitializePhysics ( )

inlinevirtual

Initialize the physics of the simulations

Implements Simulation.

Definition at line 103 of file ensemble_simulations.h.

    {
      int retval = ::InitializePhysics( (void*) m_sims.data(),
                                        m_nsims );
      return retval;
    }

InitializePhysicsData()

int InitializePhysicsData ( )

inlinevirtual

Initialize the physics data of the simulations

Implements Simulation.

Definition at line 111 of file ensemble_simulations.h.

    {
      for (int ns = 0; ns < m_nsims; ns++) {
        int retval = ::InitializePhysicsData( (void*) &(m_sims[ns]),
                                              ns, m_nsims, NULL );
        if (retval) {
          fprintf(stderr, "Error in EnsembleSimulations::InitializePhysicsData()\n");
          fprintf(stderr, "  InitializePhysicsData returned with error code %d on rank %d.\n",
                  retval, m_sims[ns].mpi.rank);
          return retval;
        }
      }
      return 0;
    }

InitializeSolvers()

int InitializeSolvers ( )

inlinevirtual

Initialize the numerical solvers of the simulations

Implements Simulation.

Definition at line 127 of file ensemble_simulations.h.

    {
      int retval = ::InitializeSolvers( (void*) m_sims.data(),
                                        m_nsims );
      return retval;
    }

Solve()

int Solve ( )

inlinevirtual

Run the simulation using native time integrators

Implements Simulation.

Definition at line 135 of file ensemble_simulations.h.

    {
      int retval = ::Solve( (void*) m_sims.data(),
                            m_nsims,
                            m_rank,
                            m_nproc );
      return retval;
    }

WriteErrors()

void WriteErrors ( double  a_wt_solver, double  a_wt_total  )

inlinevirtual

Write simulation errors and wall times to file

Implements Simulation.

Definition at line 145 of file ensemble_simulations.h.

    {
      ::SimWriteErrors( (void*) m_sims.data(),
                        m_nsims,
                        m_rank,
                        a_wt_solver,
                        a_wt_total );
      return;
    }

isDefined()

bool isDefined ( ) const

inlinevirtual

Return whether object is defined or not

Implements Simulation.

Definition at line 157 of file ensemble_simulations.h.

{ return m_is_defined; }

mpiCommDup()

int mpiCommDup ( )

inlinevirtual

Create duplicate MPI communicators

Implements Simulation.

Definition at line 161 of file ensemble_simulations.h.

    {
      for (int n = 0; n < m_nsims; n++) {
        MPI_Comm_dup(MPI_COMM_WORLD, &(m_sims[n].mpi.world));
      }
      return 0;
    }

usePetscTS()

void usePetscTS ( PetscBool  a_flag )

inlinevirtual

Set flag whether to use PETSc time integration

Implements Simulation.

Definition at line 172 of file ensemble_simulations.h.

    {
      for (int n = 0; n < m_nsims; n++) {
        m_sims[n].solver.use_petscTS  = a_flag;
      }
    }

SolvePETSc()

int SolvePETSc ( )

inlinevirtual

Run the simulation using PETSc time integrators

Implements Simulation.

Definition at line 180 of file ensemble_simulations.h.

    {
      int retval = ::SolvePETSc(  (void*) m_sims.data(),
                                  m_nsims,
                                  m_rank,
                                  m_nproc );
      return retval;
    }

Field Documentation

m_is_defined

bool m_is_defined

protected

Boolean to show if this object is defined

Definition at line 192 of file ensemble_simulations.h.

m_nsims

int m_nsims

protected

Number of ensemble simulations

Definition at line 193 of file ensemble_simulations.h.

m_rank

int m_rank

protected

MPI rank of this process

Definition at line 194 of file ensemble_simulations.h.

m_nproc

int m_nproc

protected

Total number of MPI ranks

Definition at line 194 of file ensemble_simulations.h.

m_sims

std::vector<SimulationObject> m_sims

protected

vector of simulation objects

Definition at line 197 of file ensemble_simulations.h.

---

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

• include/ensemble_simulations.h
• src/Simulation/EnsembleSimulationsDefine.cpp