Abstract Interfaces

Abstract InterfaceLocationDescription
cpde_eq_init_interfacepde_equations

The interface for the PDE version of init. This interface is consistent with eq_init_interface.

cpde_eq_load_globalspde_equations

The interface for the PDE version of load_globals. This interface is consistent with eq_load_globals.

cpde_eq_rhs_interfacepde_equations

The interface for the PDE version of rhs. This interface is consistent with eq_rhs_interface.

cpde_eq_save_globals_1pde_equations

The interface for the PDE version of save_globals_1. This interface is consistent with eq_save_globals_1.

cpde_eq_save_globals_2pde_equations

The interface for the PDE version of save_globals_2. This interface is consistent with eq_save_globals_2.

eff_source_evaluate_sourceeffective_source

The interface of the routine that evaluates the effective source.

Read more…
eff_source_get_dsingular_dreffective_source

The interface of the routine that evaluates the radial derivative of the singular field for a given mode and at a given radial coordinate.

eff_source_get_dsingular_dteffective_source

The interface of the routine that evaluates the time derivative of the singular field for a given mode and at a given radial coordinate.

eff_source_get_singulareffective_source

The interface of the routine that evaluates the singular field for a given mode and at a given radial coordinate.

eff_source_initeffective_source

The interface of the constructor.

eff_source_set_particle_poseffective_source

The interface of the routine that sets the state of the particle.

eff_source_set_time_windoweffective_source

The interface of the routine that sets the time window for smooth turn on of the effective source.

eq_init_interfaceequations

The initialization routine. There are no additional input arguments. The routine gets it's input from the run-time parameters.

eq_load_globalsequations

The routine where the equation can get global variables (for communication with other equations).

eq_outputequations

The routine where output of the equation's variables is done.

eq_print_dataequations

The routine where debug output (to stdout) of the equation's variables is done.

eq_rhs_interfaceequations

The RHS routine that sets the RHS variables from the current state of the system.

eq_save_globals_1equations

The routine where the equation can set global variables (for communication with other equations) for the first time.

eq_save_globals_2equations

The routine where the equation can set global variables (for communication with other equations) for the first time.

eq_set_to_zero_interfaceequations

Set either the main, RHS or temporary variables to zero.

eq_update_vars_interfaceequations

The routine that updates the variables defined in an equation. This is used to make the time integrator agnostic to how storage for the variables in the system of equations are set up.

Read more…
integrator_init_interfacemethod_of_lines

Initialize an integrator.

integrator_ntemp_interfacemethod_of_lines

The return value is the number of temporary storage levels are needed.

integrator_shutdown_interfacemethod_of_lines

Shut down this integrator.

integrator_step_interfacemethod_of_lines

Take a time step.

obs_extract_interfaceobservers

The extraction routine.

obs_init_interfaceobservers

The initialization routine.

obs_output_interfaceobservers

The output routine.

ode_eq_init_interfaceode_equations

The interface for the ODE version of init. This interface is consistent with eq_init_interface.

ode_eq_load_globalsode_equations

The interface for the ODE version of load_globals. This interface is consistent with eq_load_globals.

ode_eq_outputode_equations

The interface for the ODE version of output. This interface is consistent with eq_output.

ode_eq_rhs_interfaceode_equations

The interface for the ODE version of rhs. This interface is consistent with eq_rhs_interface.

ode_eq_save_globals_1ode_equations

The interface for the ODE version of save_globals_1. This interface is consistent with eq_save_globals_1.

ode_eq_save_globals_2ode_equations

The interface for the ODE version of save_globals_2. This interface is consistent with eq_save_globals_2.