Loading...
Searching...
No Matches
BlockVector.h
// Copyright (C) 2008 Kent-Andre Mardal
//
// 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 Anders Logg, 2008.
// Modified by Garth N. Wells, 2011.
//
// First added: 2008-08-25
// Last changed: 2011-01-22
//
#ifndef __BLOCKVECTOR_H
#define __BLOCKVECTOR_H
#include <string>
#include <vector>
#include <memory>
#include <dolfin/common/types.h>
namespace dolfin
{
class GenericVector;
class BlockVector
{
public:
BlockVector(std::size_t n = 0);
virtual ~BlockVector();
virtual BlockVector* copy() const;
void set_block(std::size_t i, std::shared_ptr<GenericVector> v);
std::shared_ptr<const GenericVector> get_block(std::size_t i) const;
std::shared_ptr<GenericVector> get_block(std::size_t);
void axpy(double a, const BlockVector& x);
double inner(const BlockVector& x) const;
double norm(std::string norm_type) const;
double min() const;
double max() const;
const BlockVector& operator*= (double a);
const BlockVector& operator/= (double a);
const BlockVector& operator+= (const BlockVector& x);
const BlockVector& operator-= (const BlockVector& x);
const BlockVector& operator= (const BlockVector& x);
const BlockVector& operator= (double a);
virtual bool empty() const;
std::size_t size() const;
std::string str(bool verbose) const;
private:
std::vector<std::shared_ptr<GenericVector>> vectors;
};
}
#endif
dolfin::BlockVector::empty
virtual bool empty() const
Return true if empty.
Definition BlockVector.cpp:75
dolfin::BlockVector::inner
double inner(const BlockVector &x) const
Return inner product with given vector.
Definition BlockVector.cpp:91
dolfin::BlockVector::operator=
const BlockVector & operator=(const BlockVector &x)
Assignment operator.
Definition BlockVector.cpp:167
dolfin::BlockVector::operator+=
const BlockVector & operator+=(const BlockVector &x)
Add given vector.
Definition BlockVector.cpp:155
dolfin::BlockVector::set_block
void set_block(std::size_t i, std::shared_ptr< GenericVector > v)
Set function.
Definition BlockVector.cpp:56
dolfin::BlockVector::max
double max() const
Return maximum value of vector.
Definition BlockVector.cpp:132
dolfin::BlockVector::~BlockVector
virtual ~BlockVector()
Destructor.
Definition BlockVector.cpp:43
dolfin::BlockVector::operator-=
const BlockVector & operator-=(const BlockVector &x)
Subtract given vector.
Definition BlockVector.cpp:161
dolfin::BlockVector::norm
double norm(std::string norm_type) const
Return norm of vector.
Definition BlockVector.cpp:99
dolfin::BlockVector::get_block
std::shared_ptr< const GenericVector > get_block(std::size_t i) const
Get sub-vector (const).
Definition BlockVector.cpp:63
dolfin::BlockVector::axpy
void axpy(double a, const BlockVector &x)
Add multiple of given vector (AXPY operation).
Definition BlockVector.cpp:85
dolfin::BlockVector::operator/=
const BlockVector & operator/=(double a)
Divide vector by given number.
Definition BlockVector.cpp:148
dolfin::BlockVector::str
std::string str(bool verbose) const
Return informal string representation (pretty-print).
Definition BlockVector.cpp:181
dolfin::BlockVector::size
std::size_t size() const
Number of vectors.
Definition BlockVector.cpp:80
dolfin::BlockVector::operator*=
const BlockVector & operator*=(double a)
Multiply vector by given number.
Definition BlockVector.cpp:141
dolfin::BlockVector::copy
virtual BlockVector * copy() const
Return copy of tensor.
Definition BlockVector.cpp:48
dolfin::BlockVector::min
double min() const
Return minimum value of vector.
Definition BlockVector.cpp:123
dolfin::BlockVector::BlockVector
BlockVector(std::size_t n=0)
Constructor.
Definition BlockVector.cpp:37
dolfin::GenericVector
This class defines a common interface for vectors.
Definition GenericVector.h:48
dolfin
Definition adapt.h:30