hypre/multivector/multivector.h
falgout e3181f26b1 Added 64 bit feature using HYPRE_Int (see tracker [issue489] for details).
Changed MPI routines to hypre_MPI routines.
Added hypre_printf, etc. routines.
Added AUTOTEST tests to look for 'int' and 'MPI_' calls.
Added a new approach for the Fortran interface (not implemented everywhere yet).
2010-12-20 19:27:44 +00:00

116 lines
3.5 KiB
C

/*BHEADER**********************************************************************
* Copyright (c) 2008, Lawrence Livermore National Security, LLC.
* Produced at the Lawrence Livermore National Laboratory.
* This file is part of HYPRE. See file COPYRIGHT for details.
*
* HYPRE is free software; you can redistribute it and/or modify it under the
* terms of the GNU Lesser General Public License (as published by the Free
* Software Foundation) version 2.1 dated February 1999.
*
* $Revision$
***********************************************************************EHEADER*/
#ifndef MULTIVECTOR_FUNCTION_PROTOTYPES
#define MULTIVECTOR_FUNCTION_PROTOTYPES
#include "interpreter.h"
#include "_hypre_utilities.h"
/* abstract multivector */
typedef struct mv_MultiVector* mv_MultiVectorPtr;
/* The functions below simply call the respective functions pointed to
in the HYPRE_InterfaceInterpreter structure */
#ifdef __cplusplus
extern "C" {
#endif
/* returns pointer to "real" multivector data (x->data) */
void *
mv_MultiVectorGetData (mv_MultiVectorPtr x);
/* wraps our multivector structure around the data provided by user */
mv_MultiVectorPtr
mv_MultiVectorWrap( mv_InterfaceInterpreter* ii, void * data, HYPRE_Int ownsData );
/* creates a multivector of width n using sample vector */
mv_MultiVectorPtr
mv_MultiVectorCreateFromSampleVector( void*, HYPRE_Int n, void* sample );
/* creates a multivector of the same shape as x; copies values
if copyValues is non-zero */
mv_MultiVectorPtr
mv_MultiVectorCreateCopy( mv_MultiVectorPtr x, HYPRE_Int copyValues );
void
mv_MultiVectorDestroy( mv_MultiVectorPtr );
HYPRE_Int
mv_MultiVectorWidth( mv_MultiVectorPtr v );
HYPRE_Int
mv_MultiVectorHeight( mv_MultiVectorPtr v );
/* sets mask for v; all the subsequent operations
apply only to masked vectors */
void
mv_MultiVectorSetMask( mv_MultiVectorPtr v, HYPRE_Int* mask );
void
mv_MultiVectorClear( mv_MultiVectorPtr );
void
mv_MultiVectorSetRandom( mv_MultiVectorPtr v, HYPRE_Int seed );
void
mv_MultiVectorCopy( mv_MultiVectorPtr src, mv_MultiVectorPtr dest );
/* computes y = a*x + y */
void
mv_MultiVectorAxpy( double a, mv_MultiVectorPtr x, mv_MultiVectorPtr y );
/* computes the matrix v = x'*y stored in fortran style: gh is the leading dimension,
h the number of rows and w the number of columns (cf. blas or lapack) */
void
mv_MultiVectorByMultiVector( mv_MultiVectorPtr x, mv_MultiVectorPtr y,
HYPRE_Int gh, HYPRE_Int h, HYPRE_Int w, double* v );
/*computes the diagonal of x'*y stored in diag(mask) */
void
mv_MultiVectorByMultiVectorDiag( mv_MultiVectorPtr, mv_MultiVectorPtr,
HYPRE_Int* mask, HYPRE_Int n, double* diag );
/* computes y = x*v, where v is stored in fortran style */
void
mv_MultiVectorByMatrix( mv_MultiVectorPtr x,
HYPRE_Int gh, HYPRE_Int h, HYPRE_Int w, double* v,
mv_MultiVectorPtr y );
/* computes y = x*v + y, where v is stored in fortran style */
void
mv_MultiVectorXapy( mv_MultiVectorPtr x,
HYPRE_Int gh, HYPRE_Int h, HYPRE_Int w, double* v,
mv_MultiVectorPtr y );
/* computes y = x*diag(mask) */
void mv_MultiVectorByDiagonal( mv_MultiVectorPtr x,
HYPRE_Int* mask, HYPRE_Int n, double* diag,
mv_MultiVectorPtr y );
/* computes y = f(x) vector-by-vector */
void
mv_MultiVectorEval( void (*f)( void*, void*, void* ),
void* par,
mv_MultiVectorPtr x,
mv_MultiVectorPtr y );
#ifdef __cplusplus
}
#endif
#endif /* MULTIVECTOR_FUNCTION_PROTOTYPES */