Rate This Document

Findability

Accuracy

Completeness

Readability

KmlScadssInit

Create a solver operation handle.

Interface Definition

C interface:

int KmlScadssInit(KmlScadssSolver **pSolver, const KmlDssInitOption *basicOptions, const KmlScadssInitOption *scaOptions);

Parameters

Parameter	Type	Description	Input/Output
pSolver	KmlScadssSolver **	Solver handle, which is a variable passed from a previous step.	Input/Output
basicOptions	KmlDssInitOption *	Basic solver configuration options, which cannot be a null pointer. For details, see Table 1.	Input
scaOptions	KmlScadssInitOption *	Distributed solver configuration options. For details, see Table 1.	Input

**Table 1** KmlScadssInitOption structure
Field	Type	Description
fieldMask	uint64_t	Mask that determines to which fields the configuration is applied. If a bit is set to 1, its corresponding field uses a specified value. If a bit is set to 0, its corresponding field uses the default value. See the individual field description for configurable mask bits.
comm	MPI_Comm	MPI communicator. Mask bit: KMLSCADSS_OPTIONS_COMM
autotune	int8_t	Whether to allow the solver instance to automatically adjust the input process-to-thread ratio for better performance. However, this parameter does not adjust the number of processes and threads for fill-in reduction. The options are as follows: 0: disables automatic adjustment. This is the default option. 1: enables automatic adjustment. Mask bit: KMLSCADSS_OPTIONS_AUTOTUNE

Return Value

Return Value	Type	Description
KMLSS_NO_ERROR	int	Normal execution.
KMLSS_INTERNAL_ERROR	int	Internal error.
KMLSS_NULL_ARGUMENT	int	A null argument exists in {pSolver, basicOptions, scaOptions}.

Dependencies

#include "kml_scadss.h"

Parent topic: Solver Functions