double_vector.h

Go to the documentation of this file.

// LIC// ====================================================================
// LIC// This file forms part of oomph-lib, the object-oriented,
// LIC// multi-physics finite-element library, available
// LIC// at http://www.oomph-lib.org.
// LIC//
// LIC// Copyright (C) 2006-2022 Matthias Heil and Andrew Hazel
// LIC//
// LIC// This library is free software; you can redistribute it and/or
// LIC// modify it under the terms of the GNU Lesser General Public
// LIC// License as published by the Free Software Foundation; either
// LIC// version 2.1 of the License, or (at your option) any later version.
// LIC//
// LIC// This library is distributed in the hope that it will be useful,
// LIC// but WITHOUT ANY WARRANTY; without even the implied warranty of
// LIC// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
// LIC// Lesser General Public License for more details.
// LIC//
// LIC// You should have received a copy of the GNU Lesser General Public
// LIC// License along with this library; if not, write to the Free Software
// LIC// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
// LIC// 02110-1301  USA.
// LIC//
// LIC// The authors may be contacted at oomph-lib@maths.man.ac.uk.
// LIC//
// LIC//====================================================================
#ifndef OOMPH_DOUBLE_VECTOR_CLASS_HEADER
#define OOMPH_DOUBLE_VECTOR_CLASS_HEADER
 
// Config header generated by autoconfig
#ifdef HAVE_CONFIG_H
#include <oomph-lib-config.h>
#endif
 
#ifdef OOMPH_HAS_MPI
#include "mpi.h"
#endif
 
// c++ headers
#include <algorithm>
#include <ostream>
 
// oomph headers
#include "linear_algebra_distribution.h"
 
 
namespace oomph
{
  class CRDoubleMatrix;
 
  //=============================================================================
  //=============================================================================
  class DoubleVector : public DistributableLinearAlgebraObject
  {
  public:
    DoubleVector() : Values_pt(0), Internal_values(true), Built(false) {}
 
    DoubleVector(const LinearAlgebraDistribution* const& dist_pt,
                 const double& v = 0.0)
      : Values_pt(0), Internal_values(true), Built(false)
    {
      this->build(dist_pt, v);
    }
 
    DoubleVector(const LinearAlgebraDistribution& dist, const double& v = 0.0)
      : Values_pt(0), Internal_values(true), Built(false)
    {
      this->build(dist, v);
    }
 
    ~DoubleVector()
    {
      this->clear();
    }
 
    DoubleVector(const DoubleVector& new_vector)
      : DistributableLinearAlgebraObject(),
        Values_pt(0),
        Internal_values(true),
        Built(false)
    {
      this->build(new_vector);
    }
 
    void operator=(const DoubleVector& old_vector)
    {
      this->build(old_vector);
    }
 
    void build(const DoubleVector& old_vector);
 
    void build(const LinearAlgebraDistribution& dist, const double& v)
    {
      this->build(&dist, v);
    }
 
    void build(const LinearAlgebraDistribution* const& dist_pt,
               const double& v);
 
    void build(const LinearAlgebraDistribution& dist, const Vector<double>& v)
    {
      this->build(&dist, v);
    }
 
    void build(const LinearAlgebraDistribution* const& dist_pt,
               const Vector<double>& v);
 
    void initialise(const double& v);
 
    void initialise(const Vector<double> v);
 
    void clear()
    {
      if (Internal_values)
      {
        delete[] Values_pt;
      }
      Values_pt = 0;
      this->clear_distribution();
      Built = false;
    }
 
    // indicates whether this DoubleVector is built
    bool built() const
    {
      return Built;
    }
 
    void set_external_values(const LinearAlgebraDistribution* const& dist_pt,
                             double* external_values,
                             bool delete_external_values)
    {
      // clean the memory
      this->clear();
 
      // Set the distribution
      this->build_distribution(dist_pt);
      // Say that it's built
      Built = true;
 
      // set the external values
      set_external_values(external_values, delete_external_values);
    }
 
    void set_external_values(double* external_values,
                             bool delete_external_values)
    {
#ifdef PARANOID
      // check that this distribution is setup
      if (!this->distribution_built())
      {
        // if this vector does not own the double* values then it cannot be
        // distributed.
        // note: this is not stictly necessary - would just need to be careful
        // with delete[] below.
        std::ostringstream error_message;
        error_message << "The distribution of the vector must be setup before "
                      << "external values can be set";
        throw OomphLibError(error_message.str(),
                            OOMPH_CURRENT_FUNCTION,
                            OOMPH_EXCEPTION_LOCATION);
      }
#endif
      if (Internal_values)
      {
        delete[] Values_pt;
      }
      Values_pt = external_values;
      Internal_values = delete_external_values;
    }
 
    void redistribute(const LinearAlgebraDistribution* const& dist_pt);
 
    double& operator[](int i);
 
    bool operator==(const DoubleVector& v);
 
    void operator+=(const DoubleVector& v);
 
    void operator-=(const DoubleVector& v);
 
    void operator*=(const double& d);
 
    void operator/=(const double& d);
 
    const double& operator[](int i) const;
 
    friend std::ostream& operator<<(std::ostream& out, const DoubleVector& v);
 
    double max() const;
 
    double* values_pt()
    {
      return Values_pt;
    }
 
    double* values_pt() const
    {
      return Values_pt;
    }
 
    void output(std::ostream& outfile, const int& output_precision = -1) const;
 
    void output(std::string filename, const int& output_precision = -1) const
    {
      // Open file
      std::ofstream some_file;
      some_file.open(filename.c_str());
      output(some_file, output_precision);
      some_file.close();
    }
 
    void output_local_values(std::ostream& outfile,
                             const int& output_precision = -1) const;
 
    void output_local_values(std::string filename,
                             const int& output_precision = -1) const
    {
      // Open file
      std::ofstream some_file;
      some_file.open(filename.c_str());
      output_local_values(some_file, output_precision);
      some_file.close();
    }
 
    void output_local_values_with_offset(
      std::ostream& outfile, const int& output_precision = -1) const;
 
    void output_local_values_with_offset(std::string filename,
                                         const int& output_precision = -1) const
    {
      // Open file
      std::ofstream some_file;
      some_file.open(filename.c_str());
      output_local_values_with_offset(some_file, output_precision);
      some_file.close();
    }
 
    double dot(const DoubleVector& vec) const;
 
    double norm() const;
 
    double norm(const CRDoubleMatrix* matrix_pt) const;
 
  private:
    double* Values_pt;
 
    bool Internal_values;
 
    bool Built;
 
  }; // end of DoubleVector
 
  //=================================================================
  //=================================================================
  namespace DoubleVectorHelpers
  {
    void concatenate(const Vector<DoubleVector*>& in_vector_pt,
                     DoubleVector& out_vector);
 
    void concatenate(Vector<DoubleVector>& in_vector, DoubleVector& out_vector);
 
    void split(const DoubleVector& in_vector,
               Vector<DoubleVector*>& out_vector_pt);
 
    void split(const DoubleVector& in_vector, Vector<DoubleVector>& out_vector);
 
    void concatenate_without_communication(
      const Vector<DoubleVector*>& in_vector_pt, DoubleVector& out_vector);
 
    void concatenate_without_communication(Vector<DoubleVector>& in_vector,
                                           DoubleVector& out_vector);
 
    void split_without_communication(const DoubleVector& in_vector,
                                     Vector<DoubleVector*>& out_vector_pt);
 
    void split_without_communication(const DoubleVector& in_vector,
                                     Vector<DoubleVector>& out_vector);
 
  } // namespace DoubleVectorHelpers
 
} // namespace oomph
#endif