/usr/include/ug/ls.h is in libug-dev 3.12.1-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 | // -*- tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 2 -*-
// vi: set et ts=4 sw=2 sts=2:
/****************************************************************************/
/* */
/* File: ls.h */
/* */
/* Purpose: definition of the linear solver num proc type */
/* */
/* Author: Christian Wieners */
/* Institut fuer Computeranwendungen III */
/* Universitaet Stuttgart */
/* Pfaffenwaldring 27 */
/* 70569 Stuttgart */
/* email: ug@ica3.uni-stuttgart.de */
/* */
/* History: November 29, 1996 */
/* */
/* Remarks: */
/* */
/****************************************************************************/
/* RCS_ID
$Header$
*/
/****************************************************************************/
/* */
/* auto include mechanism and other include files */
/* */
/****************************************************************************/
#ifndef __LS__
#define __LS__
#include "np.h"
#include "namespace.h"
START_UGDIM_NAMESPACE
/****************************************************************************/
/* */
/* defines in the following order */
/* */
/* compile time constants defining static data size (i.e. arrays) */
/* other constants */
/* macros */
/* */
/****************************************************************************/
#define LINEAR_SOLVER_CLASS_NAME "linear_solver"
/* access macros */
#define NPLS_A(p) (((NP_LINEAR_SOLVER*)(p))->A)
#define NPLS_b(p) (((NP_LINEAR_SOLVER*)(p))->b)
#define NPLS_x(p) (((NP_LINEAR_SOLVER*)(p))->x)
#define NPLS_red(p) (((NP_LINEAR_SOLVER*)(p))->reduction)
#define NPLS_abs(p) (((NP_LINEAR_SOLVER*)(p))->abslimit)
#define NPLS_setbasetime(p) (((NP_LINEAR_SOLVER*)(p))->setbasetime)
#define NPLS_printbasetime(p) (((NP_LINEAR_SOLVER*)(p))->printbasetime)
/****************************************************************************/
/* */
/* definition of exported data structures */
/* */
/****************************************************************************/
/* a data type for returning the status of the computation */
typedef struct {
INT error_code; /* error code */
INT converged; /* error code */
VEC_SCALAR first_defect; /* first defect */
VEC_SCALAR last_defect; /* last defect */
INT number_of_linear_iterations; /* number of iterations */
} LRESULT;
struct np_linear_solver {
NP_BASE base; /* inherits base class */
/* data (optional, necessary for calling the generic execute routine) */
VECDATA_DESC *x; /* solution */
VECDATA_DESC *b; /* defect */
MATDATA_DESC *A; /* matrix */
VEC_SCALAR reduction; /* reduction factor */
VEC_SCALAR abslimit; /* absolute limit for the defect */
INT setbasetime; /* collect time portions for base level solver */
INT printbasetime; /* print collected time for base level solver */
/* functions */
INT (*PreProcess)
(struct np_linear_solver *, /* pointer to (derived) object */
INT, /* level */
VECDATA_DESC *, /* solution vector */
VECDATA_DESC *, /* defect vector */
MATDATA_DESC *, /* matrix */
INT *, /* baselevel used by the solver */
INT *); /* result */
INT (*Defect) /* b := b - Ax */
(struct np_linear_solver *, /* pointer to (derived) object */
INT, /* level */
VECDATA_DESC *, /* solution vector */
VECDATA_DESC *, /* defect vector */
MATDATA_DESC *, /* matrix */
INT *); /* result */
INT (*Residuum) /* computes norm of the defect */
(struct np_linear_solver *, /* pointer to (derived) object */
INT, /* from level */
INT, /* to level */
VECDATA_DESC *, /* solution vector */
VECDATA_DESC *, /* defect vector */
MATDATA_DESC *, /* matrix */
LRESULT *); /* result structure */
INT (*Solver) /* b := b - Ax */
(struct np_linear_solver *, /* pointer to (derived) object */
INT, /* level */
VECDATA_DESC *, /* solution vector */
VECDATA_DESC *, /* defect vector */
MATDATA_DESC *, /* matrix */
VEC_SCALAR, /* reduction factor */
VEC_SCALAR, /* absolute limit for the defect */
LRESULT *); /* result structure */
INT (*PostProcess)
(struct np_linear_solver *, /* pointer to (derived) object */
INT, /* level */
VECDATA_DESC *, /* solution vector */
VECDATA_DESC *, /* defect vector */
MATDATA_DESC *, /* matrix */
INT *); /* result */
};
typedef struct np_linear_solver NP_LINEAR_SOLVER;
typedef INT (*PreProcessLinearSolverProcPtr) \
(NP_LINEAR_SOLVER *, INT, VECDATA_DESC *, VECDATA_DESC *, MATDATA_DESC *, \
INT *, INT *);
typedef INT (*LinearDefectProcPtr) \
(NP_LINEAR_SOLVER *, INT, VECDATA_DESC *, VECDATA_DESC *, MATDATA_DESC *, \
INT *);
typedef INT (*LinearResiduumProcPtr) \
(NP_LINEAR_SOLVER *, INT, VECDATA_DESC *, VECDATA_DESC *, MATDATA_DESC *, \
LRESULT *);
typedef INT (*LinearSolverProcPtr) \
(NP_LINEAR_SOLVER *, INT, VECDATA_DESC *, VECDATA_DESC *, MATDATA_DESC *, \
VEC_SCALAR, VEC_SCALAR, LRESULT *);
typedef INT (*PostProcessLinearSolverProcPtr) \
(NP_LINEAR_SOLVER *, INT, VECDATA_DESC *, VECDATA_DESC *, MATDATA_DESC *, \
INT *);
/****************************************************************************/
/* */
/* definition of exported functions */
/* */
/****************************************************************************/
/* generic init function for LinearSolver num procs */
INT NPLinearSolverInit (NP_LINEAR_SOLVER *theNP, INT argc , char **argv);
/* generic display function for LinearSolver num procs */
INT NPLinearSolverDisplay (NP_LINEAR_SOLVER *theNP);
/* generic execute function for LinearSolver num procs */
INT NPLinearSolverExecute (NP_BASE *theNP, INT argc , char **argv);
/* create standard LinearSolver num proc type */
INT InitLinearSolver (void);
END_UGDIM_NAMESPACE
#endif
|