exp4 Namespace Reference

Functions
int	integrate (const double t_start, const double t_end, const double pr, double *y)
	4th-order exponential integrator function w/ adaptive Kyrlov subspace approximation More...
void	init_solver_log ()
	Initializes the Krylov subspace logging files (if LOG_OUTPUT is defined) More...
void	solver_log ()
	Executes solver specific logging tasks. More...
void	initialize_solver (int num_threads)
	Initializes the solver. More...
const char *	solver_name ()
	Returns a descriptive solver name. More...
void	cleanup_solver (int num_threads)
	Cleans up the created solvers. More...
void	check_error (int tid, int code)
	Checks the return code of the given thread (IVP) for an error, and exits if found. More...

Detailed Description

Include common code.

Function Documentation

check_error()

void exp4::check_error	(	int	tid,
		int	code
	)

Checks the return code of the given thread (IVP) for an error, and exits if found.

Parameters

tid	The thread (IVP) index
code	The return code of the thread

See also

Return codes of EXP4 integrator

Definition at line 23 of file exp4_props.c.

cleanup_solver()

void exp4::cleanup_solver

(

int

num_threads

)

Cleans up the created solvers.

Parameters

num_threads

The number of OpenMP threads used

Frees and cleans up allocated CVODE memory.

Parameters

num_threads

The number of OpenMP threads used

Frees and cleans up allocated RK78 memory.

Definition at line 64 of file exp4_init.c.

init_solver_log()

exp4::init_solver_log

(

)

Initializes the Krylov subspace logging files (if LOG_OUTPUT is defined)

Initializes solver specific items for logging.

See also

solver_options.cuh

Definition at line 21 of file exp4_init.c.

initialize_solver()

void exp4::initialize_solver

(

int

num_threads

)

Initializes the solver.

Parameters

num_threads

The number of OpenMP threads to use

Definition at line 50 of file exp4_init.c.

integrate()

int exp4::integrate	(	const double	t_start,
		const double	t_end,
		const double	pr,
		double *	y
	)

4th-order exponential integrator function w/ adaptive Kyrlov subspace approximation

A header definition of the integrate method, that must be implemented by various solvers.

Parameters

t_start	The initial integration time
t_end	The final integration timestep
pr	User data passed to the RHS function dydt() - commonly used for the Pressure term
y	The state vector

Returns

The result of this integration step

See also

Return codes of EXP4 integrator

Definition at line 46 of file exp4.c.

solver_log()

void exp4::solver_log

(

)

Executes solver specific logging tasks.

Definition at line 43 of file exp4_init.c.

solver_name()

char * exp4::solver_name

(

)

Returns a descriptive solver name.

Definition at line 59 of file exp4_init.c.