mirror of
https://github.com/ultimatepp/ultimatepp.git
synced 2026-06-16 14:15:26 -06:00
192 lines
8.5 KiB
C
192 lines
8.5 KiB
C
/* -----------------------------------------------------------------
|
|
* Programmer(s): Scott D. Cohen, Alan C. Hindmarsh, Radu Serban,
|
|
* and Aaron Collier @ LLNL
|
|
* -----------------------------------------------------------------
|
|
* SUNDIALS Copyright Start
|
|
* Copyright (c) 2002-2020, Lawrence Livermore National Security
|
|
* and Southern Methodist University.
|
|
* All rights reserved.
|
|
*
|
|
* See the top-level LICENSE and NOTICE files for details.
|
|
*
|
|
* SPDX-License-Identifier: BSD-3-Clause
|
|
* SUNDIALS Copyright End
|
|
* -----------------------------------------------------------------
|
|
* This is the header file for the serial implementation of the
|
|
* NVECTOR module.
|
|
*
|
|
* Notes:
|
|
*
|
|
* - The definition of the generic N_Vector structure can be found
|
|
* in the header file sundials_nvector.h.
|
|
*
|
|
* - The definition of the type 'realtype' can be found in the
|
|
* header file sundials_types.h, and it may be changed (at the
|
|
* configuration stage) according to the user's needs.
|
|
* The sundials_types.h file also contains the definition
|
|
* for the type 'booleantype'.
|
|
*
|
|
* - N_Vector arguments to arithmetic vector operations need not
|
|
* be distinct. For example, the following call:
|
|
*
|
|
* N_VLinearSum_Serial(a,x,b,y,y);
|
|
*
|
|
* (which stores the result of the operation a*x+b*y in y)
|
|
* is legal.
|
|
* -----------------------------------------------------------------*/
|
|
|
|
#ifndef _NVECTOR_SERIAL_H
|
|
#define _NVECTOR_SERIAL_H
|
|
|
|
#include <stdio.h>
|
|
#include <sundials/sundials_nvector.h>
|
|
|
|
#ifdef __cplusplus /* wrapper to enable C++ usage */
|
|
extern "C" {
|
|
#endif
|
|
|
|
/*
|
|
* -----------------------------------------------------------------
|
|
* SERIAL implementation of N_Vector
|
|
* -----------------------------------------------------------------
|
|
*/
|
|
|
|
struct _N_VectorContent_Serial {
|
|
sunindextype length; /* vector length */
|
|
booleantype own_data; /* data ownership flag */
|
|
realtype *data; /* data array */
|
|
};
|
|
|
|
typedef struct _N_VectorContent_Serial *N_VectorContent_Serial;
|
|
|
|
/*
|
|
* -----------------------------------------------------------------
|
|
* Macros NV_CONTENT_S, NV_DATA_S, NV_OWN_DATA_S,
|
|
* NV_LENGTH_S, and NV_Ith_S
|
|
* -----------------------------------------------------------------
|
|
*/
|
|
|
|
#define NV_CONTENT_S(v) ( (N_VectorContent_Serial)(v->content) )
|
|
|
|
#define NV_LENGTH_S(v) ( NV_CONTENT_S(v)->length )
|
|
|
|
#define NV_OWN_DATA_S(v) ( NV_CONTENT_S(v)->own_data )
|
|
|
|
#define NV_DATA_S(v) ( NV_CONTENT_S(v)->data )
|
|
|
|
#define NV_Ith_S(v,i) ( NV_DATA_S(v)[i] )
|
|
|
|
/*
|
|
* -----------------------------------------------------------------
|
|
* Functions exported by nvector_serial
|
|
* -----------------------------------------------------------------
|
|
*/
|
|
|
|
SUNDIALS_EXPORT N_Vector N_VNew_Serial(sunindextype vec_length);
|
|
|
|
SUNDIALS_EXPORT N_Vector N_VNewEmpty_Serial(sunindextype vec_length);
|
|
|
|
SUNDIALS_EXPORT N_Vector N_VMake_Serial(sunindextype vec_length, realtype *v_data);
|
|
|
|
SUNDIALS_EXPORT N_Vector* N_VCloneVectorArray_Serial(int count, N_Vector w);
|
|
|
|
SUNDIALS_EXPORT N_Vector* N_VCloneVectorArrayEmpty_Serial(int count, N_Vector w);
|
|
|
|
SUNDIALS_EXPORT void N_VDestroyVectorArray_Serial(N_Vector* vs, int count);
|
|
|
|
SUNDIALS_EXPORT sunindextype N_VGetLength_Serial(N_Vector v);
|
|
|
|
SUNDIALS_EXPORT void N_VPrint_Serial(N_Vector v);
|
|
|
|
SUNDIALS_EXPORT void N_VPrintFile_Serial(N_Vector v, FILE *outfile);
|
|
|
|
SUNDIALS_EXPORT N_Vector_ID N_VGetVectorID_Serial(N_Vector v);
|
|
SUNDIALS_EXPORT N_Vector N_VCloneEmpty_Serial(N_Vector w);
|
|
SUNDIALS_EXPORT N_Vector N_VClone_Serial(N_Vector w);
|
|
SUNDIALS_EXPORT void N_VDestroy_Serial(N_Vector v);
|
|
SUNDIALS_EXPORT void N_VSpace_Serial(N_Vector v, sunindextype *lrw, sunindextype *liw);
|
|
SUNDIALS_EXPORT realtype *N_VGetArrayPointer_Serial(N_Vector v);
|
|
SUNDIALS_EXPORT void N_VSetArrayPointer_Serial(realtype *v_data, N_Vector v);
|
|
|
|
/* standard vector operations */
|
|
SUNDIALS_EXPORT void N_VLinearSum_Serial(realtype a, N_Vector x, realtype b, N_Vector y, N_Vector z);
|
|
SUNDIALS_EXPORT void N_VConst_Serial(realtype c, N_Vector z);
|
|
SUNDIALS_EXPORT void N_VProd_Serial(N_Vector x, N_Vector y, N_Vector z);
|
|
SUNDIALS_EXPORT void N_VDiv_Serial(N_Vector x, N_Vector y, N_Vector z);
|
|
SUNDIALS_EXPORT void N_VScale_Serial(realtype c, N_Vector x, N_Vector z);
|
|
SUNDIALS_EXPORT void N_VAbs_Serial(N_Vector x, N_Vector z);
|
|
SUNDIALS_EXPORT void N_VInv_Serial(N_Vector x, N_Vector z);
|
|
SUNDIALS_EXPORT void N_VAddConst_Serial(N_Vector x, realtype b, N_Vector z);
|
|
SUNDIALS_EXPORT realtype N_VDotProd_Serial(N_Vector x, N_Vector y);
|
|
SUNDIALS_EXPORT realtype N_VMaxNorm_Serial(N_Vector x);
|
|
SUNDIALS_EXPORT realtype N_VWrmsNorm_Serial(N_Vector x, N_Vector w);
|
|
SUNDIALS_EXPORT realtype N_VWrmsNormMask_Serial(N_Vector x, N_Vector w, N_Vector id);
|
|
SUNDIALS_EXPORT realtype N_VMin_Serial(N_Vector x);
|
|
SUNDIALS_EXPORT realtype N_VWL2Norm_Serial(N_Vector x, N_Vector w);
|
|
SUNDIALS_EXPORT realtype N_VL1Norm_Serial(N_Vector x);
|
|
SUNDIALS_EXPORT void N_VCompare_Serial(realtype c, N_Vector x, N_Vector z);
|
|
SUNDIALS_EXPORT booleantype N_VInvTest_Serial(N_Vector x, N_Vector z);
|
|
SUNDIALS_EXPORT booleantype N_VConstrMask_Serial(N_Vector c, N_Vector x, N_Vector m);
|
|
SUNDIALS_EXPORT realtype N_VMinQuotient_Serial(N_Vector num, N_Vector denom);
|
|
|
|
/* fused vector operations */
|
|
SUNDIALS_EXPORT int N_VLinearCombination_Serial(int nvec, realtype* c, N_Vector* V,
|
|
N_Vector z);
|
|
SUNDIALS_EXPORT int N_VScaleAddMulti_Serial(int nvec, realtype* a, N_Vector x,
|
|
N_Vector* Y, N_Vector* Z);
|
|
SUNDIALS_EXPORT int N_VDotProdMulti_Serial(int nvec, N_Vector x,
|
|
N_Vector* Y, realtype* dotprods);
|
|
|
|
/* vector array operations */
|
|
SUNDIALS_EXPORT int N_VLinearSumVectorArray_Serial(int nvec,
|
|
realtype a, N_Vector* X,
|
|
realtype b, N_Vector* Y,
|
|
N_Vector* Z);
|
|
SUNDIALS_EXPORT int N_VScaleVectorArray_Serial(int nvec, realtype* c,
|
|
N_Vector* X, N_Vector* Z);
|
|
SUNDIALS_EXPORT int N_VConstVectorArray_Serial(int nvecs, realtype c,
|
|
N_Vector* Z);
|
|
SUNDIALS_EXPORT int N_VWrmsNormVectorArray_Serial(int nvecs, N_Vector* X,
|
|
N_Vector* W, realtype* nrm);
|
|
SUNDIALS_EXPORT int N_VWrmsNormMaskVectorArray_Serial(int nvecs, N_Vector* X,
|
|
N_Vector* W, N_Vector id,
|
|
realtype* nrm);
|
|
SUNDIALS_EXPORT int N_VScaleAddMultiVectorArray_Serial(int nvec, int nsum,
|
|
realtype* a,
|
|
N_Vector* X,
|
|
N_Vector** Y,
|
|
N_Vector** Z);
|
|
SUNDIALS_EXPORT int N_VLinearCombinationVectorArray_Serial(int nvec, int nsum,
|
|
realtype* c,
|
|
N_Vector** X,
|
|
N_Vector* Z);
|
|
|
|
/* OPTIONAL local reduction kernels (no parallel communication) */
|
|
SUNDIALS_EXPORT realtype N_VWSqrSumLocal_Serial(N_Vector x, N_Vector w);
|
|
SUNDIALS_EXPORT realtype N_VWSqrSumMaskLocal_Serial(N_Vector x, N_Vector w, N_Vector id);
|
|
|
|
/*
|
|
* -----------------------------------------------------------------
|
|
* Enable / disable fused vector operations
|
|
* -----------------------------------------------------------------
|
|
*/
|
|
|
|
SUNDIALS_EXPORT int N_VEnableFusedOps_Serial(N_Vector v, booleantype tf);
|
|
|
|
SUNDIALS_EXPORT int N_VEnableLinearCombination_Serial(N_Vector v, booleantype tf);
|
|
SUNDIALS_EXPORT int N_VEnableScaleAddMulti_Serial(N_Vector v, booleantype tf);
|
|
SUNDIALS_EXPORT int N_VEnableDotProdMulti_Serial(N_Vector v, booleantype tf);
|
|
|
|
SUNDIALS_EXPORT int N_VEnableLinearSumVectorArray_Serial(N_Vector v, booleantype tf);
|
|
SUNDIALS_EXPORT int N_VEnableScaleVectorArray_Serial(N_Vector v, booleantype tf);
|
|
SUNDIALS_EXPORT int N_VEnableConstVectorArray_Serial(N_Vector v, booleantype tf);
|
|
SUNDIALS_EXPORT int N_VEnableWrmsNormVectorArray_Serial(N_Vector v, booleantype tf);
|
|
SUNDIALS_EXPORT int N_VEnableWrmsNormMaskVectorArray_Serial(N_Vector v, booleantype tf);
|
|
SUNDIALS_EXPORT int N_VEnableScaleAddMultiVectorArray_Serial(N_Vector v, booleantype tf);
|
|
SUNDIALS_EXPORT int N_VEnableLinearCombinationVectorArray_Serial(N_Vector v, booleantype tf);
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#endif
|