Loading...
Searching...
No Matches
Scalar.h
// Copyright (C) 2007-2014 Anders Logg
//
// This file is part of DOLFIN.
//
// DOLFIN 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, either version 3 of the License, or
// (at your option) any later version.
//
// DOLFIN 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 Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public License
// along with DOLFIN. If not, see <http://www.gnu.org/licenses/>.
//
// Modified by Garth N. Wells, 2007-2015.
// Modified by Ola Skavhaug, 2007.
// Modified by Martin Alnaes, 2014.
#ifndef __SCALAR_H
#define __SCALAR_H
#include <string>
#include <vector>
#include <dolfin/common/MPI.h>
#include <dolfin/common/SubSystemsManager.h>
#include <dolfin/common/types.h>
#include "DefaultFactory.h"
#include "GenericTensor.h"
#include "TensorLayout.h"
namespace dolfin
{
class TensorLayout;
class Scalar : public GenericTensor
{
public:
Scalar() : Scalar(MPI_COMM_WORLD) {}
Scalar(MPI_Comm comm) : GenericTensor(), _value(0.0), _local_increment(0.0),
_mpi_comm(comm) {}
virtual ~Scalar() {}
//--- Implementation of the GenericTensor interface ---
virtual void init(const TensorLayout& tensor_layout)
{
_value = 0.0;
_local_increment = 0.0;
_mpi_comm.reset(tensor_layout.mpi_comm());
}
virtual bool empty() const
{ return false; }
virtual std::size_t rank() const
{ return 0; }
virtual std::size_t size(std::size_t dim) const
{
// TODO: This is inconsistent in two ways:
// - tensor.size(i) is defined for i < tensor.rank(), so not at all for a Scalar.
// - the number of components of a tensor is the product of the sizes, returning 0 here makes no sense.
// Is this used for anything? If yes, consider fixing that code. If no, just make this an error for any dim.
if (dim != 0)
{
dolfin_error("Scalar.h",
"get size of scalar",
"Dim must be equal to zero.");
}
return 0;
}
virtual std::pair<std::int64_t, std::int64_t>
local_range(std::size_t dim) const
{
dolfin_error("Scalar.h",
"get local range of scalar",
"The local_range() function is not available for scalars");
return {0, 0};
}
virtual void get(double* block, const dolfin::la_index* num_rows,
const dolfin::la_index * const * rows) const
{
dolfin_error("Scalar.h",
"get global value of scalar",
"The get() function is not available for scalars");
}
virtual void set(const double* block, const dolfin::la_index* num_rows,
const dolfin::la_index * const * rows)
{
dolfin_error("Scalar.h",
"set global value of scalar",
"The set() function is not available for scalars");
}
virtual void set_local(const double* block, const dolfin::la_index* num_rows,
const dolfin::la_index * const * rows)
{
dolfin_error("Scalar.h",
"set local value of scalar",
"The set_local() function is not available for scalars");
}
virtual void add(const double* block, const dolfin::la_index* num_rows,
const dolfin::la_index * const * rows)
{
dolfin_assert(block);
_local_increment += block[0];
}
virtual void add_local(const double* block, const dolfin::la_index* num_rows,
const dolfin::la_index * const * rows)
{
dolfin_assert(block);
_local_increment += block[0];
}
virtual void add(const double* block,
const std::vector<ArrayView<const dolfin::la_index>>& rows)
{
dolfin_assert(block);
_local_increment += block[0];
}
virtual void add_local(const double* block,
const std::vector<ArrayView<const dolfin::la_index>>& rows)
{
dolfin_assert(block);
_local_increment += block[0];
}
virtual void zero()
{
_value = 0.0;
_local_increment = 0.0;
}
virtual void apply(std::string mode)
{
_value = _value + MPI::sum(_mpi_comm.comm(), _local_increment);
_local_increment = 0.0;
}
virtual MPI_Comm mpi_comm() const
{ return _mpi_comm.comm(); }
virtual std::string str(bool verbose) const
{
std::stringstream s;
s << "<Scalar value " << _value << ">";
return s.str();
}
//--- Scalar interface ---
virtual std::shared_ptr<Scalar> copy() const
{
std::shared_ptr<Scalar> s(new Scalar);
s->_value = _value;
s->_local_increment = _local_increment;
s->_mpi_comm.reset(_mpi_comm.comm());
return s;
}
//--- Special functions
virtual GenericLinearAlgebraFactory& factory() const
{
DefaultFactory f;
return f.factory();
}
double get_scalar_value() const
{ return _value; }
void add_local_value(double value)
{ _local_increment += value; }
private:
// Value of scalar
double _value;
// Local intermediate value of scalar prior to apply call
double _local_increment;
// MPI communicator
dolfin::MPI::Comm _mpi_comm;
};
}
#endif
dolfin::ArrayView
Definition ArrayView.h:32
dolfin::DefaultFactory
Default linear algebra factory based on global parameter "linear_algebra_backend".
Definition DefaultFactory.h:36
dolfin::DefaultFactory::factory
static GenericLinearAlgebraFactory & factory()
Return instance of default backend.
Definition DefaultFactory.cpp:85
dolfin::GenericLinearAlgebraFactory
Base class for LinearAlgebra factories.
Definition GenericLinearAlgebraFactory.h:47
dolfin::GenericTensor
A common interface for arbitrary rank tensors.
Definition GenericTensor.h:49
dolfin::MPI::Comm
Definition MPI.h:77
dolfin::MPI::sum
static T sum(MPI_Comm comm, const T &value)
Sum values and return sum.
Definition MPI.h:814
dolfin::Scalar::add_local
virtual void add_local(const double *block, const std::vector< ArrayView< const dolfin::la_index > > &rows)
Add block of values using local indices.
Definition Scalar.h:154
dolfin::Scalar::get_scalar_value
double get_scalar_value() const
Definition Scalar.h:210
dolfin::Scalar::add_local_value
void add_local_value(double value)
Definition Scalar.h:215
dolfin::Scalar::add
virtual void add(const double *block, const dolfin::la_index *num_rows, const dolfin::la_index *const *rows)
Add block of values using global indices.
Definition Scalar.h:130
dolfin::Scalar::factory
virtual GenericLinearAlgebraFactory & factory() const
Return a factory for the default linear algebra backend.
Definition Scalar.h:202
dolfin::Scalar::Scalar
Scalar()
Create zero scalar.
Definition Scalar.h:47
dolfin::Scalar::add_local
virtual void add_local(const double *block, const dolfin::la_index *num_rows, const dolfin::la_index *const *rows)
Add block of values using local indices.
Definition Scalar.h:138
dolfin::Scalar::apply
virtual void apply(std::string mode)
Finalize assembly of tensor.
Definition Scalar.h:169
dolfin::Scalar::set_local
virtual void set_local(const double *block, const dolfin::la_index *num_rows, const dolfin::la_index *const *rows)
Set block of values using local indices.
Definition Scalar.h:121
dolfin::Scalar::set
virtual void set(const double *block, const dolfin::la_index *num_rows, const dolfin::la_index *const *rows)
Set block of values using global indices.
Definition Scalar.h:112
dolfin::Scalar::copy
virtual std::shared_ptr< Scalar > copy() const
Return copy of scalar.
Definition Scalar.h:190
dolfin::Scalar::rank
virtual std::size_t rank() const
Return tensor rank (number of dimensions).
Definition Scalar.h:71
dolfin::Scalar::local_range
virtual std::pair< std::int64_t, std::int64_t > local_range(std::size_t dim) const
Return local ownership range.
Definition Scalar.h:94
dolfin::Scalar::init
virtual void init(const TensorLayout &tensor_layout)
Initialize zero tensor using sparsity pattern.
Definition Scalar.h:59
dolfin::Scalar::mpi_comm
virtual MPI_Comm mpi_comm() const
Return MPI communicator.
Definition Scalar.h:176
dolfin::Scalar::~Scalar
virtual ~Scalar()
Destructor.
Definition Scalar.h:54
dolfin::Scalar::add
virtual void add(const double *block, const std::vector< ArrayView< const dolfin::la_index > > &rows)
Add block of values using global indices.
Definition Scalar.h:146
dolfin::Scalar::Scalar
Scalar(MPI_Comm comm)
Create zero scalar.
Definition Scalar.h:50
dolfin::Scalar::empty
virtual bool empty() const
Return true if empty.
Definition Scalar.h:67
dolfin::Scalar::str
virtual std::string str(bool verbose) const
Return informal string representation (pretty-print).
Definition Scalar.h:180
dolfin::Scalar::zero
virtual void zero()
Set all entries to zero and keep any sparse structure.
Definition Scalar.h:162
dolfin::Scalar::get
virtual void get(double *block, const dolfin::la_index *num_rows, const dolfin::la_index *const *rows) const
Get block of values.
Definition Scalar.h:103
dolfin::Scalar::size
virtual std::size_t size(std::size_t dim) const
Return size of given dimension.
Definition Scalar.h:75
dolfin::TensorLayout
Definition TensorLayout.h:42
dolfin::TensorLayout::mpi_comm
MPI_Comm mpi_comm() const
Return MPI communicator.
Definition TensorLayout.h:92
dolfin
Definition adapt.h:30
dolfin::dolfin_error
void dolfin_error(std::string location, std::string task, std::string reason,...)
Definition log.cpp:129
dolfin::la_index
PetscInt la_index
Index type for compatibility with linear algebra backend(s).
Definition types.h:32