Implementation of TimeStepper which runs a single advection-diffusion-reaction solver. More...

#include <CD_AdvectionDiffusionStepper.H>

Inheritance diagram for Physics::AdvectionDiffusion::AdvectionDiffusionStepper:

Collaboration diagram for Physics::AdvectionDiffusion::AdvectionDiffusionStepper:

Public Member Functions
	AdvectionDiffusionStepper ()
	Default constructor – only parses options.

	AdvectionDiffusionStepper (RefCountedPtr< CdrSolver > &a_solver)
	Full constructor.

virtual	~AdvectionDiffusionStepper ()
	Destructor (does nothing)

void	initialData () override
	Fill solver with initial data.

void	allocate () override
	Allocate memory.

void	postInitialize () override
	Perform post-initialization routines (there are none)

void	postCheckpointSetup () override
	Perform post-checkpoint setup routines.

int	getNumberOfPlotVariables () const override
	Get the number of plot variables.

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

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.

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

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

void	printStepReport () override
	Print a step report if you want.

void	parseRuntimeOptions () override
	Parse runtime options.

void	registerRealms () override
	Register all realms that will be used.

void	registerOperators () override
	Register all operators that will be used.

void	preRegrid (const int a_lbase, const int a_finestLevel) override
	Perform pre-regrid operations. Calls CdrSolver::preRegrid.

void	setupSolvers () override
	Instantiate the solver.

Real	advance (const Real a_dt) override
	Advancement function – advances one time step.

void	regrid (const int a_lmin, const int a_oldFinestLevel, const int a_newFinestLevel) override
	Regrid method – calls regrid method for solver.

void	postRegrid () override
	Perform post-regrid routines. This does nothing.

void	setCFL (const Real a_cfl)
	Set the CFL number.

void	setInitialData (const std::function< Real(const RealVect &a_position)> &a_initData) noexcept
	Set the initial data..

void	setVelocity (const std::function< RealVect(const RealVect &a_position)> &a_velocity) noexcept
	Set the velocity field.

void	setDiffusionCoefficient (const std::function< Real(const RealVect &a_position)> &a_diffusion) noexcept
	Set the diffusion coeffieint.

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	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.

Protected Types
enum	Integrator { Heun , IMEX }
	Switch for different integrators.

Protected Member Functions
void	parseIntegrator ()
	Parse the integration method.

Protected Attributes
RefCountedPtr< CdrSolver >	m_solver
	Reference to solver.

RefCountedPtr< AdvectionDiffusionSpecies >	m_species
	Reference to advected species.

std::string	m_realm
	Realm where the solver lives.

phase::which_phase	m_phase
	Phase where the solver lives.

std::function< RealVect(const RealVect &a_position)>	m_velocity
	Velocity field.

std::function< Real(const RealVect &a_position)>	m_diffCo
	Diffusion coefficient.

std::function< Real(const RealVect &a_initialData)>	m_initialData
	Initial data.

Real	m_minDt
	Smallest acceptable time step.

Real	m_maxDt
	Largest acceptable time step.

Real	m_cfl
	CFL number to use.

Real	m_forceCFL
	Forced CFL (overrides input options)

bool	m_debug
	For activating debugging. This is an option.

bool	m_mobile
	Mobile or not.

bool	m_diffusive
	Diffusive or not.

Integrator	m_integrator
	Integrator.

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

Implementation of TimeStepper which runs a single advection-diffusion-reaction solver.

Constructor & Destructor Documentation

◆ AdvectionDiffusionStepper()

AdvectionDiffusionStepper::AdvectionDiffusionStepper ( RefCountedPtr< CdrSolver > & a_solver )

Full constructor.

Parameters

[in] a_solver CDR solver.

Member Function Documentation

◆ advance()

Real AdvectionDiffusionStepper::advance ( const Real a_dt )

overridevirtual

Advancement function – advances one time step.

Parameters

[in] a_dt Time step to be used for advancement

Returns: a_dt

Implements TimeStepper.

◆ allocate()

void AdvectionDiffusionStepper::allocate ( )

overridevirtual

Allocate memory.

Implements TimeStepper.

◆ computeDt()

Real AdvectionDiffusionStepper::computeDt ( )

overridevirtual

Compute a time step to be used by Driver.

Implements TimeStepper.

◆ getNumberOfPlotVariables()

int AdvectionDiffusionStepper::getNumberOfPlotVariables ( ) const

overridevirtual

Get the number of plot variables.

Implements TimeStepper.

◆ getPlotVariableNames()

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

overridevirtual

Get plot variable name.

Implements TimeStepper.

◆ initialData()

void AdvectionDiffusionStepper::initialData ( )

overridevirtual

Fill solver with initial data.

Implements TimeStepper.

◆ parseRuntimeOptions()

void AdvectionDiffusionStepper::parseRuntimeOptions ( )

overridevirtual

Parse runtime options.

Reads in verbosity level, integrator, and CFL number to use.

Reimplemented from TimeStepper.

◆ postCheckpointSetup()

void AdvectionDiffusionStepper::postCheckpointSetup ( )

overridevirtual

Perform post-checkpoint setup routines.

This will set source terms, velocities, and diffusion coefficients.

Implements TimeStepper.

◆ postInitialize()

void Physics::AdvectionDiffusion::AdvectionDiffusionStepper::postInitialize ( )

inlineoverridevirtual

Perform post-initialization routines (there are none)

Implements TimeStepper.

◆ postRegrid()

void Physics::AdvectionDiffusion::AdvectionDiffusionStepper::postRegrid ( )

inlineoverridevirtual

Perform post-regrid routines. This does nothing.

Implements TimeStepper.

◆ preRegrid()

void AdvectionDiffusionStepper::preRegrid	(	const int	a_lbase,
		const int	a_finestLevel
	)

overridevirtual

Perform pre-regrid operations. Calls CdrSolver::preRegrid.

Parameters

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

Implements TimeStepper.

◆ printStepReport()

void Physics::AdvectionDiffusion::AdvectionDiffusionStepper::printStepReport ( )

inlineoverridevirtual

Print a step report if you want.

Note: Implementation does nothing.

Implements TimeStepper.

◆ registerOperators()

void AdvectionDiffusionStepper::registerOperators ( )

overridevirtual

Register all operators that will be used.

Implements TimeStepper.

◆ registerRealms()

void AdvectionDiffusionStepper::registerRealms ( )

overridevirtual

Register all realms that will be used.

Implements TimeStepper.

◆ regrid()

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

overridevirtual

Regrid method – calls regrid method for solver.

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.

◆ setCFL()

void AdvectionDiffusionStepper::setCFL ( const Real a_cfl )

Set the CFL number.

Parameters

[in] a_cfl;

◆ setDiffusionCoefficient()

void AdvectionDiffusionStepper::setDiffusionCoefficient ( const std::function< Real(const RealVect &a_position)> & a_diffusion )

noexcept

Set the diffusion coeffieint.

Parameters

[in] a_diffusion Diffusion coefficient

◆ setInitialData()

void AdvectionDiffusionStepper::setInitialData ( const std::function< Real(const RealVect &a_position)> & a_initData )

noexcept

Set the initial data..

Parameters

[in] a_initData Initial data function.

◆ setupSolvers()

void AdvectionDiffusionStepper::setupSolvers ( )

overridevirtual

Instantiate the solver.

Implements TimeStepper.

◆ setVelocity()

void AdvectionDiffusionStepper::setVelocity ( const std::function< RealVect(const RealVect &a_position)> & a_velocity )

noexcept

Set the velocity field.

Parameters

[in] a_velocity Velocity field.

◆ synchronizeSolverTimes()

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

overridevirtual

Synchronize solver times.

Parameters

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

Implements TimeStepper.

◆ writePlotData()

void AdvectionDiffusionStepper::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 to begin at.
[in]	a_outputRealm	Realm where a_output belongs
[in]	a_level	Grid level

Implements TimeStepper.

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

Physics/AdvectionDiffusion/CD_AdvectionDiffusionStepper.H
Physics/AdvectionDiffusion/CD_AdvectionDiffusionStepper.cpp

Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ AdvectionDiffusionStepper()

Member Function Documentation

◆ advance()

◆ allocate()

◆ computeDt()

◆ getNumberOfPlotVariables()

◆ getPlotVariableNames()

◆ initialData()

◆ parseRuntimeOptions()

◆ postCheckpointSetup()

◆ postInitialize()

◆ postRegrid()

◆ preRegrid()

◆ printStepReport()

◆ registerOperators()

◆ registerRealms()

◆ regrid()

◆ setCFL()

◆ setDiffusionCoefficient()

◆ setInitialData()

◆ setupSolvers()

◆ setVelocity()

◆ synchronizeSolverTimes()

◆ writePlotData()