Simulation Class Reference

Base class for a simulation. More...

#include <simulation.h>

Inheritance diagram for Simulation:

Public Member Functions
	Simulation ()
virtual	~Simulation ()
virtual int	define (int, int)=0
virtual int	ReadInputs ()=0
virtual int	Initialize ()=0
virtual int	InitialSolution ()=0
virtual int	InitializeBoundaries ()=0
virtual int	InitializeImmersedBoundaries ()=0
virtual int	InitializePhysics ()=0
virtual int	InitializePhysicsData ()=0
virtual int	InitializeSolvers ()=0
virtual int	InitializationWrapup ()
virtual int	Solve ()=0
virtual void	WriteErrors (double, double)=0
virtual bool	isDefined () const =0
virtual int	mpiCommDup ()=0
virtual void	usePetscTS (PetscBool)=0
virtual int	SolvePETSc ()=0

Detailed Description

Base class for a simulation.

Base class for a simulation This is a purely virtual base class describing a simulation.

This is a purely virtual base class describing a simulation.

Definition at line 46 of file simulation.h.

Constructor & Destructor Documentation

Simulation()

Simulation ( )

inline

Default constructor

Definition at line 51 of file simulation.h.

{ }

~Simulation()

virtual ~Simulation ( )

inlinevirtual

Destructor

Definition at line 53 of file simulation.h.

{ }

Member Function Documentation

define()

virtual int define ( int  , int    )

pure virtual

Define function

Implemented in SparseGridsSimulation, EnsembleSimulation, and SingleSimulation.

ReadInputs()

virtual int ReadInputs ( )

pure virtual

Read solver inputs

Implemented in SparseGridsSimulation, EnsembleSimulation, and SingleSimulation.

Initialize()

virtual int Initialize ( )

pure virtual

Initialize the simulations

Implemented in SparseGridsSimulation, EnsembleSimulation, and SingleSimulation.

InitialSolution()

virtual int InitialSolution ( )

pure virtual

Read initial solution for each simulation

Implemented in SparseGridsSimulation, EnsembleSimulation, and SingleSimulation.

InitializeBoundaries()

virtual int InitializeBoundaries ( )

pure virtual

Initialize the boundary conditions of the simulations

Implemented in SparseGridsSimulation, EnsembleSimulation, and SingleSimulation.

InitializeImmersedBoundaries()

virtual int InitializeImmersedBoundaries ( )

pure virtual

Initialize the immersed boundary conditions of the simulations

Implemented in SparseGridsSimulation, EnsembleSimulation, and SingleSimulation.

InitializePhysics()

virtual int InitializePhysics ( )

pure virtual

Initialize the physics of the simulations

Implemented in SparseGridsSimulation, EnsembleSimulation, and SingleSimulation.

InitializePhysicsData()

virtual int InitializePhysicsData ( )

pure virtual

Initialize the physics data of the simulations

Implemented in SparseGridsSimulation, EnsembleSimulation, and SingleSimulation.

InitializeSolvers()

virtual int InitializeSolvers ( )

pure virtual

Initialize the numerical solvers of the simulations

Implemented in SparseGridsSimulation, EnsembleSimulation, and SingleSimulation.

InitializationWrapup()

virtual int InitializationWrapup ( )

inlinevirtual

Wrap up initializations

Reimplemented in SparseGridsSimulation.

Definition at line 83 of file simulation.h.

    {
      return 0;
    }

Solve()

virtual int Solve ( )

pure virtual

Run the simulation using native time integrators

Implemented in SparseGridsSimulation, EnsembleSimulation, and SingleSimulation.

WriteErrors()

virtual void WriteErrors ( double  , double    )

pure virtual

Write simulation errors and wall times to file

Implemented in SparseGridsSimulation, EnsembleSimulation, and SingleSimulation.

isDefined()

virtual bool isDefined ( ) const

pure virtual

Function to indicate if object is defined

Implemented in SparseGridsSimulation, EnsembleSimulation, and SingleSimulation.

mpiCommDup()

virtual int mpiCommDup ( )

pure virtual

Duplicate MPI communicators

Implemented in SparseGridsSimulation, EnsembleSimulation, and SingleSimulation.

usePetscTS()

virtual void usePetscTS ( PetscBool  )

pure virtual

Set flag whether to use PETSc time integration

Implemented in SparseGridsSimulation, EnsembleSimulation, and SingleSimulation.

SolvePETSc()

virtual int SolvePETSc ( )

pure virtual

Run the simulation using PETSc time integrators

Implemented in SparseGridsSimulation, EnsembleSimulation, and SingleSimulation.

---

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

• include/simulation.h