This implementation does absolutely nothing – it instantiates a TimeStepper with empty functionality. More...

#include <CD_GeometryStepper.H>

Inheritance diagram for Physics::Geometry::GeometryStepper:

Collaboration diagram for Physics::Geometry::GeometryStepper:

Public Member Functions
	GeometryStepper ()
	Destructor (does nothing)

virtual	~GeometryStepper ()
	Destructor (does nothing)

virtual void	setupSolvers () override
	Set up solvers (does nothing)

virtual void	allocate () override
	Allocate solver internals (does nothing)

virtual void	initialData () override
	Fill solver initial data (does nothing)

virtual void	postInitialize () override
	Post initialization function (does nothing)

virtual void	postCheckpointSetup () override
	Post-restart function (does nothing)

virtual void	registerRealms () override
	Realm register – does nothing.

virtual void	registerOperators () override
	operator registration (does nothing)

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 (returns empty vector)

virtual void	writePlotData (LevelData< EBCellFAB > &a_output, int &a_icomp, const std::string a_realm, const int a_level) const override
	Write plot data to output holder (does nothing since there's no IO form this class)

virtual Real	computeDt () override
	Compute a time step to be used by Driver.

virtual Real	advance (const Real a_dt) override
	Advancement routine. Does nothing.

virtual void	synchronizeSolverTimes (const int a_step, const Real a_time, const Real a_dt) override
	Synchronzie solver times and time steps (does nothing)

virtual void	printStepReport () override
	Print a step report (does nothing)

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

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

virtual void	postRegrid () override
	Perform post-regrid operations (does nothing)

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

virtual	~TimeStepper ()
	Default destructor (does nothing)

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

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

virtual void	parseRuntimeOptions ()
	Parse runtime options.

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, const int a_level) const
	Get computational loads to be checkpointed.

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

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, const int a_lmin, const int a_finestLevel)
	Load balance grid boxes for a specified realm.

Additional Inherited Members
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.

RefCountedPtr< AmrMesh >	m_amr
	AmrMesh.

RefCountedPtr< ComputationalGeometry >	m_computationalGeometry
	Computational geometry.

Detailed Description

This implementation does absolutely nothing – it instantiates a TimeStepper with empty functionality.

The usage of this module is just to make it easy to develop/implement geometries. The user will simply set up an "application" with this module and use Driver.geometry_only=true when running his application.

Member Function Documentation

◆ advance()

Real GeometryStepper::advance ( const Real a_dt )

overridevirtual

Advancement routine. Does nothing.

Parameters

[in] a_dt Time step to be used for advancement

Returns: Returns the time step that was used.

Note: This returns the largest time step possible to ensure end-of-simulation.

Implements TimeStepper.

◆ allocate()

void GeometryStepper::allocate ( )

overridevirtual

Allocate solver internals (does nothing)

Implements TimeStepper.

◆ computeDt()

Real GeometryStepper::computeDt ( )

overridevirtual

Compute a time step to be used by Driver.

Returns: Returns 0

Implements TimeStepper.

◆ getNumberOfPlotVariables()

int GeometryStepper::getNumberOfPlotVariables ( ) const

overridevirtual

Get the number of plot variables for this time stepper.

Returns: Returns 0

Implements TimeStepper.

◆ getPlotVariableNames()

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

overridevirtual

Get plot variable names (returns empty vector)

Implements TimeStepper.

◆ initialData()

void GeometryStepper::initialData ( )

overridevirtual

Fill solver initial data (does nothing)

Implements TimeStepper.

◆ postCheckpointSetup()

void GeometryStepper::postCheckpointSetup ( )

overridevirtual

Post-restart function (does nothing)

Implements TimeStepper.

◆ postInitialize()

void GeometryStepper::postInitialize ( )

overridevirtual

Post initialization function (does nothing)

Implements TimeStepper.

◆ postRegrid()

void GeometryStepper::postRegrid ( )

overridevirtual

Perform post-regrid operations (does nothing)

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.

◆ preRegrid()

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

overridevirtual

Perform pre-regrid operations (does nothing)

Parameters

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

Implements TimeStepper.

◆ printStepReport()

void GeometryStepper::printStepReport ( )

overridevirtual

Print a step report (does nothing)

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

Implements TimeStepper.

◆ registerOperators()

void GeometryStepper::registerOperators ( )

overridevirtual

operator registration (does nothing)

Implements TimeStepper.

◆ registerRealms()

void GeometryStepper::registerRealms ( )

overridevirtual

Realm register – does nothing.

Implements TimeStepper.

◆ regrid()

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

overridevirtual

Time stepper regrid method (does nothing)

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()

void GeometryStepper::setupSolvers ( )

overridevirtual

Set up solvers (does nothing)

Implements TimeStepper.

◆ synchronizeSolverTimes()

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

overridevirtual

Synchronzie solver times and time steps (does nothing)

Parameters

[in]	a_step	Time step
[in]	a_time	Time (in seconds)
[in]	a_dt	Time step that was used.

Implements TimeStepper.

◆ writePlotData()

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

overridevirtual

Write plot data to output holder (does nothing since there's no IO form this class)

Parameters

[in,out]	a_output	Output data holder.
[in,out]	a_icomp	Starting component in a_output to begin at.
[in]	a_outputRealm	Output realm
[in]	a_level	Grid level

Implements TimeStepper.

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

Physics/Geometry/CD_GeometryStepper.H
Physics/Geometry/CD_GeometryStepper.cpp

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ advance()

◆ allocate()

◆ computeDt()

◆ getNumberOfPlotVariables()

◆ getPlotVariableNames()

◆ initialData()

◆ postCheckpointSetup()

◆ postInitialize()

◆ postRegrid()

◆ preRegrid()

◆ printStepReport()

◆ registerOperators()

◆ registerRealms()

◆ regrid()

◆ setupSolvers()

◆ synchronizeSolverTimes()

◆ writePlotData()