#include <ExternalPetscTimeStepper.h>

Inheritance diagram for ExternalPetscTimeStepper:

Public Types
typedef DataFileName	DataFileParameterType

Public Member Functions
	ExternalPetscTimeStepper (const InputParameters &parameters)

virtual void	init ()

virtual void	preExecute ()

virtual void	preSolve ()

virtual void	postSolve ()

virtual void	postExecute ()

virtual void	preStep ()

virtual void	postStep ()

void	computeStep ()

virtual bool	constrainStep (Real &dt)

virtual void	step ()

virtual void	acceptStep ()

virtual void	rejectStep ()

unsigned int	numFailures () const

virtual bool	converged () const

Real	getCurrentDT ()

virtual void	forceTimeStep (Real dt)

virtual void	forceNumSteps (const unsigned int num_steps)

virtual bool	enabled () const

std::shared_ptr< MooseObject >	getSharedPtr ()

std::shared_ptr< const MooseObject >	getSharedPtr () const

MooseApp &	getMooseApp () const

const std::string &	type () const

virtual const std::string &	name () const

std::string	typeAndName () const

std::string	errorPrefix (const std::string &error_type) const

void	callMooseError (std::string msg, const bool with_prefix) const

MooseObjectParameterName	uniqueParameterName (const std::string &parameter_name) const

const InputParameters &	parameters () const

MooseObjectName	uniqueName () const

const T &	getParam (const std::string &name) const

std::vector< std::pair< T1, T2 > >	getParam (const std::string &param1, const std::string &param2) const

const T *	queryParam (const std::string &name) const

const T &	getRenamedParam (const std::string &old_name, const std::string &new_name) const

T	getCheckedPointerParam (const std::string &name, const std::string &error_string="") const

bool	isParamValid (const std::string &name) const

bool	isParamSetByUser (const std::string &nm) const

void	paramError (const std::string &param, Args... args) const

void	paramWarning (const std::string &param, Args... args) const

void	paramInfo (const std::string &param, Args... args) const

void	connectControllableParams (const std::string &parameter, const std::string &object_type, const std::string &object_name, const std::string &object_parameter) const

void	mooseError (Args &&... args) const

void	mooseErrorNonPrefixed (Args &&... args) const

void	mooseDocumentedError (const std::string &repo_name, const unsigned int issue_num, Args &&... args) const

void	mooseWarning (Args &&... args) const

void	mooseWarningNonPrefixed (Args &&... args) const

void	mooseDeprecated (Args &&... args) const

void	mooseInfo (Args &&... args) const

std::string	getDataFileName (const std::string &param) const

std::string	getDataFileNameByName (const std::string &relative_path) const

std::string	getDataFilePath (const std::string &relative_path) const

const std::vector< MooseVariableScalar *> &	getCoupledMooseScalarVars ()

const std::set< TagID > &	getScalarVariableCoupleableVectorTags () const

const std::set< TagID > &	getScalarVariableCoupleableMatrixTags () const

void	addSyncTime (Real sync_time)

void	addSyncTime (const std::set< Real > &times)

void	addSyncTime (Real sync_time)

void	addSyncTime (const std::set< Real > &times)

const Parallel::Communicator &	comm () const

processor_id_type	n_processors () const

processor_id_type	processor_id () const

Static Public Member Functions
static InputParameters	validParams ()

Public Attributes
const ConsoleStream	_console

Protected Member Functions
virtual Real	computeInitialDT () override

virtual Real	computeDT () override

virtual Real	computeFailedDT ()

T &	declareRestartableData (const std::string &data_name, Args &&... args)

ManagedValue< T >	declareManagedRestartableDataWithContext (const std::string &data_name, void *context, Args &&... args)

const T &	getRestartableData (const std::string &data_name) const

T &	declareRestartableDataWithContext (const std::string &data_name, void *context, Args &&... args)

T &	declareRecoverableData (const std::string &data_name, Args &&... args)

T &	declareRestartableDataWithObjectName (const std::string &data_name, const std::string &object_name, Args &&... args)

T &	declareRestartableDataWithObjectNameWithContext (const std::string &data_name, const std::string &object_name, void *context, Args &&... args)

std::string	restartableName (const std::string &data_name) const

bool	isCoupledScalar (const std::string &var_name, unsigned int i=0) const

unsigned int	coupledScalarComponents (const std::string &var_name) const

unsigned int	coupledScalar (const std::string &var_name, unsigned int comp=0) const

libMesh::Order	coupledScalarOrder (const std::string &var_name, unsigned int comp=0) const

const VariableValue &	coupledScalarValue (const std::string &var_name, unsigned int comp=0) const

const ADVariableValue &	adCoupledScalarValue (const std::string &var_name, unsigned int comp=0) const

const GenericVariableValue< is_ad > &	coupledGenericScalarValue (const std::string &var_name, unsigned int comp=0) const

const GenericVariableValue< false > &	coupledGenericScalarValue (const std::string &var_name, const unsigned int comp) const

const GenericVariableValue< true > &	coupledGenericScalarValue (const std::string &var_name, const unsigned int comp) const

const VariableValue &	coupledVectorTagScalarValue (const std::string &var_name, TagID tag, unsigned int comp=0) const

const VariableValue &	coupledMatrixTagScalarValue (const std::string &var_name, TagID tag, unsigned int comp=0) const

const VariableValue &	coupledScalarValueOld (const std::string &var_name, unsigned int comp=0) const

const VariableValue &	coupledScalarValueOlder (const std::string &var_name, unsigned int comp=0) const

const VariableValue &	coupledScalarDot (const std::string &var_name, unsigned int comp=0) const

const ADVariableValue &	adCoupledScalarDot (const std::string &var_name, unsigned int comp=0) const

const VariableValue &	coupledScalarDotDot (const std::string &var_name, unsigned int comp=0) const

const VariableValue &	coupledScalarDotOld (const std::string &var_name, unsigned int comp=0) const

const VariableValue &	coupledScalarDotDotOld (const std::string &var_name, unsigned int comp=0) const

const VariableValue &	coupledScalarDotDu (const std::string &var_name, unsigned int comp=0) const

const VariableValue &	coupledScalarDotDotDu (const std::string &var_name, unsigned int comp=0) const

const MooseVariableScalar *	getScalarVar (const std::string &var_name, unsigned int comp) const

Protected Attributes
FEProblemBase &	_fe_problem

TransientBase &	_executioner

Real &	_time

Real &	_time_old

int &	_t_step

Real &	_dt

Real &	_dt_min

Real &	_dt_max

Real &	_end_time

std::set< Real > &	_sync_times

Real &	_timestep_tolerance

const bool &	_verbose

bool	_converged

const Real	_cutback_factor_at_failure

bool	_reset_dt

bool	_has_reset_dt

unsigned int	_failure_count

const bool &	_enabled

MooseApp &	_app

const std::string	_type

const std::string	_name

const InputParameters &	_pars

Factory &	_factory

ActionFactory &	_action_factory

MooseApp &	_restartable_app

const std::string	_restartable_system_name

const THREAD_ID	_restartable_tid

const bool	_restartable_read_only

FEProblemBase &	_sc_fe_problem

const THREAD_ID	_sc_tid

const Real &	_real_zero

const VariableValue &	_scalar_zero

const Point &	_point_zero

const Parallel::Communicator &	_communicator

Private Attributes
ExternalPETScProblem &	_external_petsc_problem

Detailed Description

Definition at line 15 of file ExternalPetscTimeStepper.h.

Constructor & Destructor Documentation

◆ ExternalPetscTimeStepper()

ExternalPetscTimeStepper::ExternalPetscTimeStepper ( const InputParameters & parameters )

Definition at line 27 of file ExternalPetscTimeStepper.C.

   : TimeStepper(parameters),
     // ExternalPetscTimeStepper always requires ExternalPETScProblem
     _external_petsc_problem(static_cast<ExternalPETScProblem &>(_fe_problem))
 {
 }

Member Function Documentation

◆ computeDT()

Real ExternalPetscTimeStepper::computeDT ( )

overrideprotectedvirtual

Implements TimeStepper.

Definition at line 44 of file ExternalPetscTimeStepper.C.

 {
   // Query the time step size of PETSc solver
   PetscReal dt;
   LibmeshPetscCall(TSGetTimeStep(_external_petsc_problem.getPetscTS(), &dt));
   return dt;
 }

◆ computeInitialDT()

Real ExternalPetscTimeStepper::computeInitialDT ( )

overrideprotectedvirtual

Implements TimeStepper.

Definition at line 35 of file ExternalPetscTimeStepper.C.

 {
   // Query the time step size of PETSc solver
   PetscReal dt;
   LibmeshPetscCall(TSGetTimeStep(_external_petsc_problem.getPetscTS(), &dt));
   return dt;
 }

◆ validParams()

InputParameters ExternalPetscTimeStepper::validParams ( )

static

Definition at line 18 of file ExternalPetscTimeStepper.C.

 {
   InputParameters params = TimeStepper::validParams();
 
   params.addClassDescription("Timestepper that queries the step size of the external petsc solver, "
                              "and use that as the time step size.");
   return params;
 }

Member Data Documentation

◆ _external_petsc_problem

ExternalPETScProblem& ExternalPetscTimeStepper::_external_petsc_problem

private

Definition at line 27 of file ExternalPetscTimeStepper.h.

Referenced by computeDT(), and computeInitialDT().

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

external_petsc_solver/include/timesteppers/ExternalPetscTimeStepper.h
external_petsc_solver/src/timesteppers/ExternalPetscTimeStepper.C

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Private Attributes