| 1 |
// ------------------------------------------------------------------------ |
| 2 |
// |
| 3 |
// SPDX-License-Identifier: LGPL-2.1-or-later |
| 4 |
// Copyright (C) 2015 - 2023 by the deal.II authors |
| 5 |
// |
| 6 |
// This file is part of the deal.II library. |
| 7 |
// |
| 8 |
// Part of the source code is dual licensed under Apache-2.0 WITH |
| 9 |
// LLVM-exception OR LGPL-2.1-or-later. Detailed license information |
| 10 |
// governing the source code and code contributions can be found in |
| 11 |
// LICENSE.md and CONTRIBUTING.md at the top level directory of deal.II. |
| 12 |
// |
| 13 |
// ------------------------------------------------------------------------ |
| 14 |
|
| 15 |
#ifndef dealii_vector_space_vector_h |
| 16 |
#define dealii_vector_space_vector_h |
| 17 |
|
| 18 |
#include <deal.II/base/config.h> |
| 19 |
|
| 20 |
#include <memory> |
| 21 |
|
| 22 |
|
| 23 |
DEAL_II_NAMESPACE_OPEN |
| 24 |
|
| 25 |
// ---------------------------- Free functions -------------------------- |
| 26 |
|
| 27 |
namespace LinearAlgebra |
| 28 |
{ |
| 29 |
/** |
| 30 |
* Shift all entries of the vector by a constant factor so that the mean |
| 31 |
* value of the vector becomes zero. |
| 32 |
*/ |
| 33 |
template <typename VectorType> |
| 34 |
void |
| 35 |
set_zero_mean_value(VectorType &vector) |
| 36 |
{ |
| 37 |
vector.add(-vector.mean_value()); |
| 38 |
} |
| 39 |
} // namespace LinearAlgebra |
| 40 |
|
| 41 |
DEAL_II_NAMESPACE_CLOSE |
| 42 |
|
| 43 |
#endif |