SingleSimulation Class Reference

Class describing a single simulation. More...

#include <single_simulation.h>

Inheritance diagram for SingleSimulation:

Public Member Functions
	SingleSimulation ()
	~SingleSimulation ()
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_rank
int	m_nproc
SimulationObject *	m_sim

Detailed Description

Class describing a single simulation.

Class describing a single simulation This class contains all data and functions needed to run a single simulation.

This class contains all data and functions needed to run a single simulation.

Definition at line 26 of file single_simulation.h.

Constructor & Destructor Documentation

SingleSimulation()

SingleSimulation ( )

inline

Constructor

Definition at line 31 of file single_simulation.h.

    {
      m_is_defined = false;
      m_sim = nullptr;
      m_nproc = -1;
      m_rank = -1;
    }

~SingleSimulation()

~SingleSimulation ( )

inline

Destructor

Definition at line 40 of file single_simulation.h.

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

Member Function Documentation

define()

int define ( int  a_rank, int  a_nproc  )

virtual

Define this object

Define the single simulation object

Parameters

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

Implements Simulation.

Definition at line 10 of file SingleSimulationDefine.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;

  m_sim = new SimulationObject;
  m_sim->solver.my_idx = 0;
  m_sim->solver.nsims = 1;
  m_sim->mpi.rank = m_rank;
  m_sim->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 54 of file single_simulation.h.

    {
      int retval = ::ReadInputs(  (void*) m_sim,
                                  _NSIMS_, 
                                  m_rank );
      ::WriteInputs( (void*) m_sim,
                     _NSIMS_, 
                     m_rank );
      return retval;
    }

Initialize()

int Initialize ( )

inlinevirtual

Initialize the simulations

Implements Simulation.

Definition at line 66 of file single_simulation.h.

    {
      int retval = ::Initialize(  (void*) m_sim,
                                  _NSIMS_ );
      return retval;
    }

InitialSolution()

int InitialSolution ( )

inlinevirtual

Read initial solution for each simulation

Implements Simulation.

Definition at line 74 of file single_simulation.h.

    {
      int retval = ::InitialSolution( (void*) m_sim,
                                      _NSIMS_ );
      return retval;
    }

InitializeBoundaries()

int InitializeBoundaries ( )

inlinevirtual

Initialize the boundary conditions of the simulations

Implements Simulation.

Definition at line 82 of file single_simulation.h.

    {
      int retval = ::InitializeBoundaries(  (void*) m_sim,
                                            _NSIMS_ );
      return retval;
    }

InitializeImmersedBoundaries()

int InitializeImmersedBoundaries ( )

inlinevirtual

Initialize the immersed boundary conditions of the simulations

Implements Simulation.

Definition at line 90 of file single_simulation.h.

    {
      int retval = ::InitializeImmersedBoundaries(  (void*) m_sim,
                                                    _NSIMS_ );
      return retval;
    }

InitializePhysics()

int InitializePhysics ( )

inlinevirtual

Initialize the physics of the simulations

Implements Simulation.

Definition at line 98 of file single_simulation.h.

    {
      int retval = ::InitializePhysics( (void*) m_sim,
                                        _NSIMS_ );
      return retval;
    }

InitializePhysicsData()

int InitializePhysicsData ( )

inlinevirtual

Initialize the physics data of the simulations

Implements Simulation.

Definition at line 106 of file single_simulation.h.

    {
      int retval = ::InitializePhysicsData( (void*) m_sim,
                                            0, _NSIMS_, NULL );
      return retval;
    }

InitializeSolvers()

int InitializeSolvers ( )

inlinevirtual

Initialize the numerical solvers of the simulations

Implements Simulation.

Definition at line 114 of file single_simulation.h.

    {
      int retval = ::InitializeSolvers( (void*) m_sim,
                                        _NSIMS_ );
      return retval;
    }

Solve()

int Solve ( )

inlinevirtual

Run the simulation using native time integrators

Implements Simulation.

Definition at line 122 of file single_simulation.h.

    {
      int retval = ::Solve( (void*) m_sim,
                            _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 132 of file single_simulation.h.

    {
      ::SimWriteErrors( (void*) m_sim,
                        _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 144 of file single_simulation.h.

{ return m_is_defined; }

mpiCommDup()

int mpiCommDup ( )

inlinevirtual

Create duplicate MPI communicators

Implements Simulation.

Definition at line 148 of file single_simulation.h.

    {
      MPI_Comm_dup(MPI_COMM_WORLD, &(m_sim->mpi.world));
      return 0;
    }

usePetscTS()

void usePetscTS ( PetscBool  a_flag )

inlinevirtual

Set flag whether to use PETSc time integration

Implements Simulation.

Definition at line 157 of file single_simulation.h.

    {
      m_sim->solver.use_petscTS  = a_flag;
    }

SolvePETSc()

int SolvePETSc ( )

inlinevirtual

Run the simulation using PETSc time integrators

Implements Simulation.

Definition at line 163 of file single_simulation.h.

    {
      int retval = ::SolvePETSc(  (void*) m_sim,
                                  _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 175 of file single_simulation.h.

m_rank

int m_rank

protected

MPI rank of this process

Definition at line 176 of file single_simulation.h.

m_nproc

int m_nproc

protected

Total number of MPI ranks

Definition at line 176 of file single_simulation.h.

m_sim

SimulationObject* m_sim

protected

Definition at line 179 of file single_simulation.h.

---

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

• include/single_simulation.h
• src/Simulation/SingleSimulationDefine.cpp