fcs_pepc_p.h File Reference

file containing all pepc specific functions (public version) More...

#include "fcs_definitions.h"
#include "fcs_result_p.h"
#include "fcs_interface_p.h"

Include dependency graph for fcs_pepc_p.h:

Go to the source code of this file.

Typedefs
typedef struct fcs_pepc_parameters_t *	fcs_pepc_parameters

Functions
FCSResult	fcs_pepc_set_epsilon (FCS handle, fcs_float epsilon)
	function to set the optional pepc epsilon parameter More...
FCSResult	fcs_pepc_get_epsilon (FCS handle, fcs_float *epsilon)
	function to get the optional pepc epsilon parameter More...
FCSResult	fcs_pepc_set_theta (FCS handle, fcs_float theta)
	function to set the optional pepc theta parameter More...
FCSResult	fcs_pepc_get_theta (FCS handle, fcs_float *theta)
	function to get the optional pepc theta parameter More...
FCSResult	fcs_pepc_set_debug_level (FCS handle, fcs_int level)
	function to set the pepc debug level More...
FCSResult	fcs_pepc_get_debug_level (FCS handle, fcs_int *level)
	function to get the pepc debug level More...
FCSResult	fcs_pepc_set_num_walk_threads (FCS handle, fcs_int num_walk_threads)
	function to set pepcs number of walk threads per MPI rank More...
FCSResult	fcs_pepc_get_num_walk_threads (FCS handle, fcs_int *num_walk_threads)
	function to get pepcs number of walk threads per MPI rank More...
FCSResult	fcs_pepc_set_load_balancing (FCS handle, fcs_int load_balancing)
	function for setting pepcs switch for load balancing More...
FCSResult	fcs_pepc_get_load_balancing (FCS handle, fcs_int *load_balancing)
	function for getting pepcs switch for load balancing More...
FCSResult	fcs_pepc_set_dipole_correction (FCS handle, fcs_int dipole_correction)
	function for setting pepcs switch for adding a dipole correction for periodic systems More...
FCSResult	fcs_pepc_get_dipole_correction (FCS handle, fcs_int *dipole_correction)
	function for getting pepcs switch for adding a dipole correction for periodic systems More...
FCSResult	fcs_pepc_set_npm (FCS handle, fcs_float npm)
	function to set the optional pepc npm (aka np_mult) More...
FCSResult	fcs_pepc_get_npm (FCS handle, fcs_float *npm)
	function to get the optional pepc npm (aka np_mult) More...
FCSResult	fcs_pepc_setup (FCS handle, fcs_float epsilon, fcs_float theta)
void	fcs_pepc_setup_f (void *handle, fcs_float epsilon, fcs_float theta, fcs_int level, fcs_int *return_value)

Detailed Description

file containing all pepc specific functions (public version)

Author

Rene Halver

Definition in file fcs_pepc_p.h.

Typedef Documentation

fcs_pepc_parameters

typedef struct fcs_pepc_parameters_t* fcs_pepc_parameters

Definition at line 35 of file fcs_pepc_p.h.

Function Documentation

fcs_pepc_get_debug_level()

FCSResult fcs_pepc_get_debug_level	(	FCS	handle,
		fcs_int *	level
	)

function to get the pepc debug level

Parameters

handle	FCS-object that contains the parameter
level	user-set debug level of pepc solver

Returns

the debug level

fcs_pepc_get_dipole_correction()

FCSResult fcs_pepc_get_dipole_correction	(	FCS	handle,
		fcs_int *	dipole_correction
	)

function for getting pepcs switch for adding a dipole correction for periodic systems

Parameters

handle	FCS-object that contains the parameter
dipole_correction	if >0 the dipole correction is enabled

fcs_pepc_get_epsilon()

FCSResult fcs_pepc_get_epsilon	(	FCS	handle,
		fcs_float *	epsilon
	)

function to get the optional pepc epsilon parameter

Parameters

handle	FCS-object that contains the parameter
epsilon	epsilon (Plummer potential parameter)

Returns

FCSResult-object containing the return state

fcs_pepc_get_load_balancing()

FCSResult fcs_pepc_get_load_balancing	(	FCS	handle,
		fcs_int *	load_balancing
	)

function for getting pepcs switch for load balancing

Parameters

handle	FCS-object that contains the parameter
load_balancing	if >0 load balancing is enabled. may only be activated if the frontend does not reorder any particles

fcs_pepc_get_npm()

FCSResult fcs_pepc_get_npm	(	FCS	handle,
		fcs_float *	npm
	)

function to get the optional pepc npm (aka np_mult)

Parameters

handle	FCS-object that is modified
npm	npm (aka np_mult)

Returns

FCSResult-object containing the return state

fcs_pepc_get_num_walk_threads()

FCSResult fcs_pepc_get_num_walk_threads	(	FCS	handle,
		fcs_int *	num_walk_threads
	)

function to get pepcs number of walk threads per MPI rank

Parameters

handle	FCS-object that contains the parameter
num_walk_threads	number of traversal threads per rank

fcs_pepc_get_theta()

FCSResult fcs_pepc_get_theta	(	FCS	handle,
		fcs_float *	theta
	)

function to get the optional pepc theta parameter

Parameters

handle	FCS-object that contains the parameter
theta	multipole acceptance parameter for Barnes-Hut MAC

Returns

FCSResult-object containing the return state

fcs_pepc_set_debug_level()

FCSResult fcs_pepc_set_debug_level	(	FCS	handle,
		fcs_int	level
	)

function to set the pepc debug level

Parameters

handle	FCS-object that is modified
level	user-set debug level of pepc solver

Returns

FCSResult-object containing the return state

fcs_pepc_set_dipole_correction()

FCSResult fcs_pepc_set_dipole_correction	(	FCS	handle,
		fcs_int	dipole_correction
	)

function for setting pepcs switch for adding a dipole correction for periodic systems

Parameters

handle	FCS-object that contains the parameter
dipole_correction	if >0 the dipole correction is enabled

fcs_pepc_set_epsilon()

FCSResult fcs_pepc_set_epsilon	(	FCS	handle,
		fcs_float	epsilon
	)

function to set the optional pepc epsilon parameter

Parameters

handle	FCS-object that is modified
epsilon	epsilon (Plummer potential parameter)

Returns

FCSResult-object containing the return state

fcs_pepc_set_load_balancing()

FCSResult fcs_pepc_set_load_balancing	(	FCS	handle,
		fcs_int	load_balancing
	)

function for setting pepcs switch for load balancing

Parameters

handle	FCS-object that contains the parameter
load_balancing	if >0 load balancing is enabled. may only be activated if the frontend does not reorder any particles

fcs_pepc_set_npm()

FCSResult fcs_pepc_set_npm	(	FCS	handle,
		fcs_float	npm
	)

function to set the optional pepc npm (aka np_mult)

Parameters

handle	FCS-object that is modified
npm	npm (aka np_mult)

Returns

FCSResult-object containing the return state

fcs_pepc_set_num_walk_threads()

FCSResult fcs_pepc_set_num_walk_threads	(	FCS	handle,
		fcs_int	num_walk_threads
	)

function to set pepcs number of walk threads per MPI rank

Parameters

handle	FCS-object that contains the parameter
num_walk_threads	number of traversal threads per rank

fcs_pepc_set_theta()

FCSResult fcs_pepc_set_theta	(	FCS	handle,
		fcs_float	theta
	)

function to set the optional pepc theta parameter

Parameters

handle	FCS-object that is modified
theta	multipole acceptance parameter for Barnes-Hut MAC

Returns

FCSResult-object containing the return state

fcs_pepc_setup()

FCSResult fcs_pepc_setup	(	FCS	handle,
		fcs_float	epsilon,
		fcs_float	theta
	)

fcs_pepc_setup_f()

void fcs_pepc_setup_f	(	void *	handle,
		fcs_float	epsilon,
		fcs_float	theta,
		fcs_int	level,
		fcs_int *	return_value
	)