Homec4science
Diffusion LibMultiScale (features/components) Browse

libmultiscale/src/math/array.hh
1e97b3b33259features/components

Last Change
Raw File

array.hh
View Options

/**
* @file array.hh
*
* @author Guillaume Anciaux <guillaume.anciaux@epfl.ch>
*
* @date Fri Jul 11 15:47:44 2014
*
* @brief This is a wrapper to a vector type to be used when algebra is needed
*
* @section LICENSE
*
* Copyright INRIA and CEA
*
* The LibMultiScale is a C++ parallel framework for the multiscale
* coupling methods dedicated to material simulations. This framework
* provides an API which makes it possible to program coupled simulations
* and integration of already existing codes.
*
* This Project was initiated in a collaboration between INRIA Futurs Bordeaux
* within ScAlApplix team and CEA/DPTA Ile de France.
* The project is now continued at the Ecole Polytechnique Fédérale de Lausanne
* within the LSMS/ENAC laboratory.
*
* This software is governed by the CeCILL-C license under French law and
* abiding by the rules of distribution of free software. You can use,
* modify and/ or redistribute the software under the terms of the CeCILL-C
* license as circulated by CEA, CNRS and INRIA at the following URL
* "http://www.cecill.info".
*
* As a counterpart to the access to the source code and rights to copy,
* modify and redistribute granted by the license, users are provided only
* with a limited warranty and the software's author, the holder of the
* economic rights, and the successive licensors have only limited
* liability.
*
* In this respect, the user's attention is drawn to the risks associated
* with loading, using, modifying and/or developing or reproducing the
* software by the user in light of its specific status of free software,
* that may mean that it is complicated to manipulate, and that also
* therefore means that it is reserved for developers and experienced
* professionals having in-depth computer knowledge. Users are therefore
* encouraged to load and test the software's suitability as regards their
* requirements in conditions enabling the security of their systems and/or
* data to be ensured and, more generally, to use and operate it in the
* same conditions as regards security.
*
* The fact that you are presently reading this means that you have had
* knowledge of the CeCILL-C license and that you accept its terms.
*
*/
#ifndef __LIBMULTISCALE_ARRAY_HH__
#define __LIBMULTISCALE_ARRAY_HH__
/* -------------------------------------------------------------------------- */
#include <vector>
#include "lm_macros.hh"
#include "lm_types.hh"
/* -------------------------------------------------------------------------- */
__BEGIN_LIBMULTISCALE__
class Array {
/* ------------------------------------------------------------------------ */
/* Constructors/Destructors */
/* ------------------------------------------------------------------------ */
public:
Array(UInt t);
Array();
~Array();
/* ------------------------------------------------------------------------ */
/* Methods */
/* ------------------------------------------------------------------------ */
//! return value indexed by i
inline Real &operator()(UInt i) { return vector[i]; };
//! return value indexed by i
inline Real &operator[](UInt i) { return vector[i]; };
//! prUInt vetor to file specified by name
void printToFile(char *f, UInt step = 0);
//! prUInt vetor to file specified by FILE * pointer
UInt printToFile(std::ofstream &f, UInt step = 0);
//! return a contiguous zone of memory where values are stored
Real *getArray();
//! set vector to zero
UInt zero();
//! scale vector by value a
void scale(Real a);
UInt size();
void close();
void add(UInt i, Real val);
/* ------------------------------------------------------------------------ */
/* Class Members */
/* ------------------------------------------------------------------------ */
protected:
//! array of Reals storing the values
std::vector<Real> vector;
};
__END_LIBMULTISCALE__
#endif /* __LIBMULTISCALE_ARRAY_HH__ */
c4science · Help