Public Attributes
NLenum	state
	State of the finite-state automaton.

NLboolean	user_variable_buffers
	NL_TRUE if variables are allocated by the user, NL_FALSE if they are managed by OpenNL.

NLBufferBinding *	variable_buffer
	Buffer bindings for the variables, dimension = nb_systems.

NLdouble *	variable_value
	Values of the variables, dimension = nb_systems * nb_variables.

NLboolean *	variable_is_locked
	Locked flags of the variables, dimension = nb_variables.

NLuint *	variable_index
	Index of the variable in the actual linear system, dimension = nb_variables.

NLuint	n
	The number of not locked variables.

NLenum	matrix_mode
	The current matrix mode.

NLMatrix	M
	The matrix of the system.

NLMatrix	P
	The preconditioner.

NLMatrix	B
	The right-hand side matrix.

NLRowColumn	af
	The coefficients that correspond to the free variables in the row being built.

NLRowColumn	al
	The coefficients that correspond to the locked variables in the row being built.

NLdouble *	x
	The vector of free variables, solution of the system.

NLdouble *	b
	The vector of right hand sides, of size nb_systems * n.

NLdouble *	right_hand_side
	The right hand sides of the row being built. An array of nb_systems doubles.

NLdouble	row_scaling
	The scaling coefficient for the row being build.

NLenum	solver
	The used solver, as a symbolic constant.

NLenum	preconditioner
	The used preconditioner, as a symbolic constant.

NLboolean	preconditioner_defined
	True if preconditioner was defined by client.

NLuint	nb_variables
	The number of variables.

NLuint	nb_systems
	The number of linear systems to solve.

NLboolean	ij_coefficient_called
	True if NLIJCoefficient() was called.

NLuint	current_row
	The index of the current row.

NLboolean	least_squares
	Indicates whether a least squares system is constructed.

NLboolean	symmetric
	Indicates whether the matrix is symmetric.

NLuint	max_iterations
	Maximum number of iterations.

NLboolean	max_iterations_defined
	True if max_iterations was defined by client.

NLuint	inner_iterations
	Maximum number of inner iterations.

NLdouble	threshold
	Convergence threshold.

NLboolean	threshold_defined
	True if threshold was defined by client.

NLdouble	omega
	Relaxation parameter for the SSOR preconditioner.

NLboolean	normalize_rows
	If true, all the rows are normalized.

NLuint	used_iterations
	used number of iterations during latest solve.

NLdouble	error
	error obtained after latest solve.

NLdouble	start_time
	start time marking the beginning of latest solve.

NLdouble	elapsed_time
	elapsed time for latest solve.

NLSolverFunc	solver_func
	the function pointer for the solver.

NLProgressFunc	progress_func
	the function pointer for logging progress.

NLboolean	verbose
	if true, some logging information is displayed during solve.

NLulong	flops
	Total number of floating point operations used during latest solve.

NLenum	eigen_solver
	The eigen solver. Should be NL_ARPACK_EXT.

NLdouble	eigen_shift
	The shift parameter of the spectral shift-invert transform.

NLboolean	eigen_shift_invert
	NL_TRUE if spectral shift-invert transform is used, NL_FALSE otherwise;.

NLdouble *	eigen_value
	the array of eigen values. Dimension = nb_systems.

NLdouble *	temp_eigen_value
	temporary array for eigen values, used for sorting.

NLboolean	has_matrix_pattern
	true if nlBegin(NL_MATRIX_PATTERN) was called.

NLboolean	no_variables_indirection
	if no_variables_indirection is set, then there is no locked variable, and the linear system directly uses the variables vector and right-hand-side.

Detailed Description

Definition at line 104 of file nl_context.h.

Member Data Documentation

◆ af

NLRowColumn NLContextStruct::af

The coefficients that correspond to the free variables in the row being built.

Indices correspond to system indices, within [0..n-1].

Definition at line 174 of file nl_context.h.

◆ al

NLRowColumn NLContextStruct::al

The coefficients that correspond to the locked variables in the row being built.

Indices correspond to variables indices, within [0..nb_variables-1].

Definition at line 182 of file nl_context.h.

◆ B

NLMatrix NLContextStruct::B

The right-hand side matrix.

Used by the eigen solver for generalized eigenproblems.

Definition at line 166 of file nl_context.h.

◆ b

NLdouble* NLContextStruct::b

The vector of right hand sides, of size nb_systems * n.

Definition at line 193 of file nl_context.h.

◆ current_row

NLuint NLContextStruct::current_row

The index of the current row.

Definition at line 242 of file nl_context.h.

◆ eigen_shift

NLdouble NLContextStruct::eigen_shift

The shift parameter of the spectral shift-invert transform.

Definition at line 348 of file nl_context.h.

◆ eigen_shift_invert

NLboolean NLContextStruct::eigen_shift_invert

NL_TRUE if spectral shift-invert transform is used, NL_FALSE otherwise;.

Definition at line 354 of file nl_context.h.

◆ eigen_solver

NLenum NLContextStruct::eigen_solver

The eigen solver. Should be NL_ARPACK_EXT.

Definition at line 342 of file nl_context.h.

◆ eigen_value

NLdouble* NLContextStruct::eigen_value

the array of eigen values. Dimension = nb_systems.

Definition at line 359 of file nl_context.h.

◆ elapsed_time

NLdouble NLContextStruct::elapsed_time

elapsed time for latest solve.

Definition at line 315 of file nl_context.h.

◆ error

NLdouble NLContextStruct::error

error obtained after latest solve.

Definition at line 303 of file nl_context.h.

◆ flops

NLulong NLContextStruct::flops

Total number of floating point operations used during latest solve.

Definition at line 337 of file nl_context.h.

◆ has_matrix_pattern

NLboolean NLContextStruct::has_matrix_pattern

true if nlBegin(NL_MATRIX_PATTERN) was called.

Definition at line 372 of file nl_context.h.

◆ ij_coefficient_called

NLboolean NLContextStruct::ij_coefficient_called

True if NLIJCoefficient() was called.

Definition at line 237 of file nl_context.h.

◆ inner_iterations

NLuint NLContextStruct::inner_iterations

Maximum number of inner iterations.

used by GMRES.

Definition at line 270 of file nl_context.h.

◆ least_squares

NLboolean NLContextStruct::least_squares

Indicates whether a least squares system is constructed.

Definition at line 248 of file nl_context.h.

◆ M

NLMatrix NLContextStruct::M

The matrix of the system.

Definition at line 154 of file nl_context.h.

◆ matrix_mode

NLenum NLContextStruct::matrix_mode

The current matrix mode.

One of NL_STIFFNESS_MATRIX, NL_MASS_MATRIX.

Definition at line 149 of file nl_context.h.

◆ max_iterations

NLuint NLContextStruct::max_iterations

Maximum number of iterations.

Definition at line 258 of file nl_context.h.

◆ max_iterations_defined

NLboolean NLContextStruct::max_iterations_defined

True if max_iterations was defined by client.

Definition at line 264 of file nl_context.h.

◆ n

NLuint NLContextStruct::n

The number of not locked variables.

Definition at line 142 of file nl_context.h.

◆ nb_systems

NLuint NLContextStruct::nb_systems

The number of linear systems to solve.

Definition at line 232 of file nl_context.h.

◆ nb_variables

NLuint NLContextStruct::nb_variables

The number of variables.

Definition at line 227 of file nl_context.h.

◆ no_variables_indirection

NLboolean NLContextStruct::no_variables_indirection

if no_variables_indirection is set, then there is no locked variable, and the linear system directly uses the variables vector and right-hand-side.

Definition at line 379 of file nl_context.h.

◆ normalize_rows

NLboolean NLContextStruct::normalize_rows

If true, all the rows are normalized.

Definition at line 293 of file nl_context.h.

◆ omega

NLdouble NLContextStruct::omega

Relaxation parameter for the SSOR preconditioner.

Definition at line 288 of file nl_context.h.

◆ P

NLMatrix NLContextStruct::P

The preconditioner.

Definition at line 159 of file nl_context.h.

◆ preconditioner

NLenum NLContextStruct::preconditioner

The used preconditioner, as a symbolic constant.

Definition at line 217 of file nl_context.h.

◆ preconditioner_defined

NLboolean NLContextStruct::preconditioner_defined

True if preconditioner was defined by client.

Definition at line 222 of file nl_context.h.

◆ progress_func

NLProgressFunc NLContextStruct::progress_func

the function pointer for logging progress.

Definition at line 325 of file nl_context.h.

◆ right_hand_side

NLdouble* NLContextStruct::right_hand_side

The right hand sides of the row being built. An array of nb_systems doubles.

Specified by nlRightHandSide() and nlMultiRightHandSide()

Definition at line 200 of file nl_context.h.

◆ row_scaling

NLdouble NLContextStruct::row_scaling

The scaling coefficient for the row being build.

Specified by nlSetRowParameter(NL_ROW_SCALING, rhs)

Definition at line 207 of file nl_context.h.

◆ solver

NLenum NLContextStruct::solver

The used solver, as a symbolic constant.

Definition at line 212 of file nl_context.h.

◆ solver_func

NLSolverFunc NLContextStruct::solver_func

the function pointer for the solver.

Definition at line 320 of file nl_context.h.

◆ start_time

NLdouble NLContextStruct::start_time

start time marking the beginning of latest solve.

Definition at line 310 of file nl_context.h.

◆ state

NLenum NLContextStruct::state

State of the finite-state automaton.

Used to check that OpenNL functions were called in the correct order.

Definition at line 110 of file nl_context.h.

◆ symmetric

NLboolean NLContextStruct::symmetric

Indicates whether the matrix is symmetric.

Definition at line 253 of file nl_context.h.

◆ temp_eigen_value

NLdouble* NLContextStruct::temp_eigen_value

temporary array for eigen values, used for sorting.

It is put in the context so that in a multithreading context, with a thread local storage context, it will continue to work.

Definition at line 367 of file nl_context.h.

◆ threshold

NLdouble NLContextStruct::threshold

Convergence threshold.

Iterations are stopped whenever \( \| A x - b \| / \| b \| < \mbox{threshold} \)

Definition at line 277 of file nl_context.h.

◆ threshold_defined

NLboolean NLContextStruct::threshold_defined

True if threshold was defined by client.

Definition at line 282 of file nl_context.h.

◆ used_iterations

NLuint NLContextStruct::used_iterations

used number of iterations during latest solve.

Definition at line 298 of file nl_context.h.

◆ user_variable_buffers

NLboolean NLContextStruct::user_variable_buffers

NL_TRUE if variables are allocated by the user, NL_FALSE if they are managed by OpenNL.

Definition at line 116 of file nl_context.h.

◆ variable_buffer

NLBufferBinding* NLContextStruct::variable_buffer

Buffer bindings for the variables, dimension = nb_systems.

Definition at line 121 of file nl_context.h.

◆ variable_index

NLuint* NLContextStruct::variable_index

Index of the variable in the actual linear system, dimension = nb_variables.

Definition at line 137 of file nl_context.h.

◆ variable_is_locked

NLboolean* NLContextStruct::variable_is_locked

Locked flags of the variables, dimension = nb_variables.

Definition at line 131 of file nl_context.h.

◆ variable_value

NLdouble* NLContextStruct::variable_value

Values of the variables, dimension = nb_systems * nb_variables.

Definition at line 126 of file nl_context.h.

◆ verbose

NLboolean NLContextStruct::verbose

if true, some logging information is displayed during solve.

Definition at line 331 of file nl_context.h.

◆ x

NLdouble* NLContextStruct::x

The vector of free variables, solution of the system.

Definition at line 188 of file nl_context.h.

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

geogram/NL/nl_context.h

Public Attributes