TimeStepper for advancing a system of N coupled ODEs on an AMR mesh. More...

#include <CD_MeshODEStepper.H>

Inheritance diagram for Physics::MeshODE::MeshODEStepper< N >:

Collaboration diagram for Physics::MeshODE::MeshODEStepper< N >:

Public Member Functions
	MeshODEStepper ()
	Constructor. Does nothing.

	MeshODEStepper (const MeshODEStepper< N > &)=delete
	Copy constructor. Disallowed.

	MeshODEStepper (const MeshODEStepper< N > &&)=delete
	Move constructor. Disallowed.

virtual	~MeshODEStepper ()
	Destructor.

MeshODEStepper &	operator= (const MeshODEStepper< N > &)=delete
	Copy assignment operator. Disallowed.

MeshODEStepper &	operator= (const MeshODEStepper< N > &&)=delete
	Move assignment operator. Disallowed.

void	setupSolvers () override
	Instantiate the ODE solver.

void	allocate () override
	Allocate storage for solvers and time stepper.

void	initialData () override
	Fill problem with initial data.

void	postInitialize () override
	Perform any post-initialization steps.

void	postCheckpointSetup () override
	Post checkpoint operations.

void	registerRealms () override
	Register realms. Primal is the only realm we need.

void	registerOperators () override
	Register operators.

void	parseOptions ()
	Parse options.

void	parseRuntimeOptions () override
	Parse runtime options.

virtual int	getNumberOfPlotVariables () const override
	Get the number of plot variables for this time stepper.

virtual Vector< std::string >	getPlotVariableNames () const override
	Get plot variable names.

virtual void	writePlotData (LevelData< EBCellFAB > &a_output, int &a_icomp, const std::string &a_outputRealm, const int a_level) const override
	Write plot data to output holder.

virtual Real	computeDt () override
	Compute a time step.

virtual Real	advance (const Real a_dt) override
	Advancement method. Swaps between various kernels.

virtual void	synchronizeSolverTimes (const int a_step, const Real a_time, const Real a_dt) override
	Synchronize solver times and time steps.

virtual void	printStepReport () override
	Print a step report.

virtual void	preRegrid (const int a_lmin, const int a_oldFinestLevel) override
	Perform pre-regrid operations.

virtual void	regrid (const int a_lmin, const int a_oldFinestLevel, const int a_newFinestLevel) override
	Time stepper regrid method.

virtual void	postRegrid () override
	Perform post-regrid operations.

Public Member Functions inherited from TimeStepper
	TimeStepper ()
	Default constructor (does nothing)

virtual	~TimeStepper ()
	Default destructor (does nothing)

	TimeStepper (const TimeStepper &)=delete
	Disallow copy construction.

TimeStepper &	operator= (const TimeStepper &)=delete
	Disallow copy assignment.

	TimeStepper (TimeStepper &&)=default
	Allow move construction.

TimeStepper &	operator= (TimeStepper &&)=default
	Allow move assignment.

void	setAmr (const RefCountedPtr< AmrMesh > &a_amr)
	Set AmrMesh.

void	setComputationalGeometry (const RefCountedPtr< ComputationalGeometry > &a_computationalGeometry)
	Set the computational geometry.

virtual void	prePlot ()
	An option for calling special functions prior to plotting data. Called by Driver in the IMMEDIATELY before writing the plot file.

virtual void	postPlot ()
	An option for calling special functions prior to plotting data. Called by Driver in the IMMEDIATELY after writing the plot file.

virtual Vector< long int >	getCheckpointLoads (const std::string &a_realm, int a_level) const
	Get computational loads to be checkpointed.

virtual bool	needToRegrid ()
	Function which can have Driver do regrids at arbitrary points in the simulation.

bool	keepGoing () const
	Query whether the time stepper wants to continue stepping.

virtual bool	loadBalanceThisRealm (const std::string &a_realm) const
	Load balancing query for a specified realm. If this returns true for a_realm, load balancing routines will be called during regrids.

virtual void	loadBalanceBoxes (Vector< Vector< int > > &a_procs, Vector< Vector< Box > > &a_boxes, const std::string &a_realm, const Vector< DisjointBoxLayout > &a_grids, int a_lmin, int a_finestLevel)
	Load balance grid boxes for a specified realm.

Protected Member Functions
virtual void	parseIntegrator ()
	Parse integrator.

virtual void	parseVerbosity ()
	Parse chattiness.

virtual void	parseProblem ()
	Parse the problem type.

virtual void	advanceEuler (const Real a_dt)
	Advance using the explicit Euler rule.

virtual void	advanceRK2 (const Real a_dt)
	Advance using a second-order Runge-Kutta method.

virtual void	advanceRK4 (const Real a_dt)
	Advance using a fourth order Runge-Kutta method.

Protected Attributes
IntegrationAlgorithm	m_algorithm
	Integration algorithm.

Real	m_dt
	Time step to use.

std::string	m_realm
	Realm where solver and m_velocity lives.

phase::which_phase	m_phase
	Phase (gas/solid) where the solver lives.

RefCountedPtr< MeshODESolver< N > >	m_solver
	MeshODE solver holding the solution on the AMR hierarchy.

std::function< std::array< Real, N >(const std::array< Real, N > y, Real t)>	m_rhsFunction
	Right-hand side function \( \mathbf{f}(\mathbf{y}, t) \) evaluated point-wise on the mesh.

std::function< std::array< Real, N >(const RealVect &a_position)>	m_initialData
	Callable that returns the initial state \( \mathbf{y}_0(\mathbf{x}) \) at a given position.

Protected Attributes inherited from TimeStepper
int	m_verbosity
	Class verbosity.

int	m_timeStep
	Time step.

Real	m_time
	TIme.

Real	m_dt
	Previous time step size.

bool	m_keepGoing
	If false, Driver will stop the time loop after the current step.

RefCountedPtr< AmrMesh >	m_amr
	AmrMesh.

RefCountedPtr< ComputationalGeometry >	m_computationalGeometry
	Computational geometry.

Detailed Description

template<size_t N>
class Physics::MeshODE::MeshODEStepper< N >

TimeStepper for advancing a system of N coupled ODEs on an AMR mesh.

At each time step the right-hand side \( \mathbf{f}(\mathbf{y}, t) \) is evaluated point-wise on the mesh and the ODE \( \dot{\mathbf{y}} = \mathbf{f}(\mathbf{y},t) \) is integrated with the chosen algorithm (Euler, RK2, or RK4). The template parameter N sets the number of solution components stored per cell.

The RHS function and initial data function must be set by the derived application before Driver calls setupSolvers().

Member Function Documentation

◆ advance()

template<size_t N>

Real MeshODEStepper::advance ( const Real a_dt )

overridevirtual

Advancement method. Swaps between various kernels.

Parameters

[in] a_dt Time step to be used for advancement

Returns: Returns the time step that was used (equal to a_dt in this case).

Implements TimeStepper.

◆ advanceEuler()

template<size_t N>

void MeshODEStepper::advanceEuler ( const Real a_dt )

protectedvirtual

Advance using the explicit Euler rule.

Parameters

[in] a_dt Advanced time step

◆ advanceRK2()

template<size_t N>

void MeshODEStepper::advanceRK2 ( const Real a_dt )

protectedvirtual

Advance using a second-order Runge-Kutta method.

Parameters

[in] a_dt Advanced time step

◆ advanceRK4()

template<size_t N>

void MeshODEStepper::advanceRK4 ( const Real a_dt )

protectedvirtual

Advance using a fourth order Runge-Kutta method.

Parameters

[in] a_dt Advanced time step

◆ allocate()

template<size_t N>

void MeshODEStepper::allocate ( )

overridevirtual

Allocate storage for solvers and time stepper.

Implements TimeStepper.

◆ computeDt()

template<size_t N>

Real MeshODEStepper::computeDt ( )

overridevirtual

Compute a time step.

Returns: The fixed time step m_dt read from input options.

Implements TimeStepper.

◆ getNumberOfPlotVariables()

template<size_t N>

int MeshODEStepper::getNumberOfPlotVariables ( ) const

overridevirtual

Get the number of plot variables for this time stepper.

This is necessary because Driver, not TimeStepper, is responsible for allocating the necessary memory.

Returns: Returns number of plot variables that will be written during writePlotData

Implements TimeStepper.

◆ getPlotVariableNames()

template<size_t N>

Vector< std::string > MeshODEStepper::getPlotVariableNames ( ) const

overridevirtual

Get plot variable names.

Returns: Vector of variable name strings contributed by this TimeStepper.

Implements TimeStepper.

◆ initialData()

template<size_t N>

void MeshODEStepper::initialData ( )

overridevirtual

Fill problem with initial data.

Implements TimeStepper.

◆ parseRuntimeOptions()

template<size_t N>

void MeshODEStepper::parseRuntimeOptions ( )

overridevirtual

Parse runtime options.

Reimplemented from TimeStepper.

◆ postCheckpointSetup()

template<size_t N>

void MeshODEStepper::postCheckpointSetup ( )

overridevirtual

Post checkpoint operations.

Implements TimeStepper.

◆ postInitialize()

template<size_t N>

void MeshODEStepper::postInitialize ( )

overridevirtual

Perform any post-initialization steps.

Implements TimeStepper.

◆ postRegrid()

template<size_t N>

void MeshODEStepper::postRegrid ( )

overridevirtual

Perform post-regrid operations.

This includes all operations to be done AFTER interpolating data to new grids.

Implements TimeStepper.

◆ preRegrid()

template<size_t N>

void MeshODEStepper::preRegrid	(	const int	a_lmin,
		const int	a_oldFinestLevel
	)

overridevirtual

Perform pre-regrid operations.

Parameters

[in]	a_lmin	The coarsest level that changes
[in]	a_oldFinestLevel	The finest level before the regrid.

Implements TimeStepper.

◆ printStepReport()

template<size_t N>

virtual void Physics::MeshODE::MeshODEStepper< N >::printStepReport ( )

inlineoverridevirtual

Print a step report.

This is called by Driver after time step. The routine can be used to display use information about the simulation progress. Not used by this class.

Implements TimeStepper.

◆ registerOperators()

template<size_t N>

void MeshODEStepper::registerOperators ( )

overridevirtual

Register operators.

Only need the solver's operators.

Implements TimeStepper.

◆ registerRealms()

template<size_t N>

void MeshODEStepper::registerRealms ( )

overridevirtual

Register realms. Primal is the only realm we need.

Implements TimeStepper.

◆ regrid()

template<size_t N>

void MeshODEStepper::regrid	(	const int	a_lmin,
		const int	a_oldFinestLevel,
		const int	a_newFinestLevel
	)

overridevirtual

Time stepper regrid method.

Parameters

[in]	a_lmin	The coarsest level that changed.
[in]	a_oldFinestLevel	The finest level before the regrid.
[in]	a_newFinestLevel	The finest level after the regrid.

Implements TimeStepper.

◆ setupSolvers()

template<size_t N>

void MeshODEStepper::setupSolvers ( )

overridevirtual

Instantiate the ODE solver.

Implements TimeStepper.

◆ synchronizeSolverTimes()

template<size_t N>

void MeshODEStepper::synchronizeSolverTimes	(	const int	a_step,
		const Real	a_time,
		const Real	a_dt
	)

overridevirtual

Synchronize solver times and time steps.

Parameters

[in]	a_step	Current time step number.
[in]	a_time	Current simulation time in seconds.
[in]	a_dt	Time step that was used.

Implements TimeStepper.

◆ writePlotData()

template<size_t N>

void MeshODEStepper::writePlotData	(	LevelData< EBCellFAB > &	a_output,
		int &	a_icomp,
		const std::string &	a_outputRealm,
		const int	a_level
	)		const

overridevirtual

Write plot data to output holder.

Parameters

[in,out]	a_output	Output data holder.
[in,out]	a_icomp	Starting component in a_output; incremented on exit.
[in]	a_outputRealm	Realm where a_output lives.
[in]	a_level	Grid level.

Implements TimeStepper.

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

Physics/MeshODE/CD_MeshODEStepper.H
Physics/MeshODE/CD_MeshODEStepperImplem.H

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

◆ advance()

◆ advanceEuler()

◆ advanceRK2()

◆ advanceRK4()

◆ allocate()

◆ computeDt()

◆ getNumberOfPlotVariables()

◆ getPlotVariableNames()

◆ initialData()

◆ parseRuntimeOptions()

◆ postCheckpointSetup()

◆ postInitialize()

◆ postRegrid()

◆ preRegrid()

◆ printStepReport()

◆ registerOperators()

◆ registerRealms()

◆ regrid()

◆ setupSolvers()

◆ synchronizeSolverTimes()

◆ writePlotData()