f77proto.h 3.27 KB
 thomas.forbriger committed Dec 23, 2002 1 2 3 4 5 /*! \file f77proto.h * \brief prototypes for Fortran interface (prototypes) * * ---------------------------------------------------------------------------- *  thomas.forbriger committed Aug 12, 2010 6  * $Id$  thomas.forbriger committed Dec 23, 2002 7 8 9 10  * \author Thomas Forbriger * \date 22/12/2002 * * prototypes for Fortran interface (prototypes)  thomas.forbriger committed Dec 27, 2002 11  *  thomas.forbriger committed Mar 28, 2006 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27  * ---- * This program is free software; you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation; either version 2 of the License, or * (at your option) any later version. * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with this program; if not, write to the Free Software * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA * ---- *  thomas.forbriger committed Dec 27, 2002 28 29  * \sa \ref page_fortran * \sa f77interface  thomas.forbriger committed Dec 23, 2002 30 31 32 33 34  * * Copyright (c) 2002 by Thomas Forbriger (IMG Frankfurt) * * REVISIONS and CHANGES * - 22/12/2002 V1.0 Thomas Forbriger  thomas.forbriger committed Dec 27, 2002 35 36  * - 27/12/2002 V1.1 (thof) * - now provides some documentation  thomas.forbriger committed Dec 23, 2002 37 38 39 40 41  * * ============================================================================ */ // include guard  thomas.forbriger committed Dec 23, 2002 42 #ifndef AFF_F77PROTO_H_VERSION  thomas.forbriger committed Dec 23, 2002 43   thomas.forbriger committed Dec 23, 2002 44 #define AFF_F77PROTO_H_VERSION \  thomas.forbriger committed Dec 27, 2002 45  "AFF_F77PROTO_H V1.1"  thomas.forbriger committed Dec 23, 2002 46 #define AFF_F77PROTO_H_CVSID \  thomas.forbriger committed Aug 12, 2010 47  "$Id$"  thomas.forbriger committed Dec 23, 2002 48   thomas.forbriger committed Dec 23, 2002 49 #include  thomas.forbriger committed Dec 23, 2002 50   thomas.forbriger committed Dec 23, 2002 51 52 #include  thomas.forbriger committed Dec 27, 2002 53 54 55 56 57 58 /*! \brief This namespace collects all test functions for interfacing Fortran 77 * * \sa \ref page_fortran * \sa tests/f77test.cc * \sa tests/f77interface.cc */  thomas.forbriger committed Dec 23, 2002 59 namespace f77interface {  thomas.forbriger committed Dec 23, 2002 60   thomas.forbriger committed Dec 23, 2002 61 62 63 typedef aff::Array > Tcarray; typedef aff::Array > Tzarray;  thomas.forbriger committed Dec 27, 2002 64 65 66 67 68 69 /*! \brief fill an AFF array thorugh a Fortran subroutine * * An aff::Array object is passed to the Fortran subroutine fill and is * filled with values there. * The concept is discussed on page "\ref page_fortran". */  thomas.forbriger committed Dec 23, 2002 70 int fill(const aff::Array& fa);  thomas.forbriger committed Dec 27, 2002 71 72 73 74 75 76 77 78 79 80  /*! \brief fill the Fortran common-block array * * Two aff::Array objects are passed to the Fortran subroutine * fillarray which calculates complex values from the elements of these arrays * and fills the array in common-block \c f77common which is defined in * tests/f77common.inc. * * The concept is discussed on page "\ref page_fortran". */  thomas.forbriger committed Dec 23, 2002 81 82 int fillarray(const aff::Array& v1, const aff::Array& v2);  thomas.forbriger committed Dec 27, 2002 83 84 85 86 87 88 89 90 91  /*! \brief returns results from Fortran subroutine sums * * The Fortran subroutine sums calculates column-sums from the array in the * common block. These values are return in an * \code aff::Array > \endcode object. * * The concept is discussed on page "\ref page_fortran". */  thomas.forbriger committed Dec 23, 2002 92 Tcarray sums();  thomas.forbriger committed Dec 27, 2002 93 94 95 96 97 98 99 100 101 102  /*! \brief returns direct access to Fortran common block * * This function returns a * \code aff::Array > \endcode object, which offers * direct read/write access to the array in the Fortran common block * f77common. * * The concept is discussed on page "\ref page_fortran". */  thomas.forbriger committed Dec 23, 2002 103 Tzarray viewcommon();  thomas.forbriger committed Dec 23, 2002 104 105 106 107 108  } // namespace f77interface #endif // AFF_F77PROTO_H_VERSION (includeguard)  thomas.forbriger committed Dec 23, 2002 109 110  /* ----- END OF f77proto.h ----- */