warpy.dt_calc.integrating_controller.integrating_controller Class Reference

Inheritance diagram for warpy.dt_calc.integrating_controller.integrating_controller:

Public Member Functions
def	__init__ (self, time_integrator, alpha, patch_process_integrators=[], init_dt=1e-2, max_dt=None, max_growth=None, error_tol=1, max_error=1, kappa=0.9, stability_limit=False)
	Chooses a time step based on an error integrating controller.
def	name (self, stage=None)
def	attrs (self, stage=None)
def	generate (self, start=None, stop=None, stride=1, explode_name=True, explode_args=True)
Public Member Functions inherited from warpy.host_actions.host_action.host_action
def	__init__ (self, name, req_attrs, opt_attrs=None, variables=None)
def	variables (self)

Public Attributes
	patch_process_integrators
Public Attributes inherited from warpy.host_actions.host_action.host_action
	vars_

Constructor & Destructor Documentation

__init__()

def warpy.dt_calc.integrating_controller.integrating_controller.__init__	(		self,
			time_integrator,
			alpha,
			patch_process_integrators = [],
			init_dt = 1e-2,
			max_dt = None,
			max_growth = None,
			error_tol = 1,
			max_error = 1,
			kappa = 0.9,
			stability_limit = False
	)

Chooses a time step based on an error integrating controller.

Parameters

time_integrator
alpha	k_I/p where k_I is the integral constant and p is the error estimation order of the time integrator. For the Dormand Prince method, alpha = 1/5
patch_process_integrators	list of patch_process_integrators to use for computing an error estimate.
init_dt	initial time step
max_dt	maximum allowed time step
max_growth	maximum rate the time step is allowed to grow
error_tol	what the desired error tolerance level is
max_error	what error level the controller should retry a timestep with a smaller timestep
kappa	specific controller parameter. Use the default value unless you know why you want to change it.
stability_limit	True if the integrating controller should take the min of the stability-based timestep and error-based timestep, or false if only the error-based timestep should be used.

Reimplemented from warpy.host_actions.host_action.host_action.

Member Function Documentation

attrs()

def warpy.dt_calc.integrating_controller.integrating_controller.attrs	(		self,
			stage = None
	)

generate()

def warpy.dt_calc.integrating_controller.integrating_controller.generate	(		self,
			start = None,
			stop = None,
			stride = 1,
			explode_name = True,
			explode_args = True
	)

name()

def warpy.dt_calc.integrating_controller.integrating_controller.name	(		self,
			stage = None
	)

Member Data Documentation

patch_process_integrators

warpy.dt_calc.integrating_controller.integrating_controller.patch_process_integrators

---

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

• tools/warpy/dt_calc/integrating_controller.py