system_norm.h

Go to the documentation of this file.

// The libMesh Finite Element Library.
// Copyright (C) 2002-2026 Benjamin S. Kirk, John W. Peterson, Roy H. Stogner
 
// This library 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 2.1 of the License, or (at your option) any later version.
 
// This library 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 this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
 
 
#ifndef LIBMESH_SYSTEM_NORM_H
#define LIBMESH_SYSTEM_NORM_H
 
// Local includes
#include "libmesh/libmesh_common.h" // for Real
 
// C++ includes
#include <vector>
 
namespace libMesh
{
 
// Forward declarations
enum FEMNormType : int;
 
class SystemNorm
{
public:
 
  SystemNorm();
 
  SystemNorm(const FEMNormType & t);
 
  explicit
  SystemNorm(std::vector<FEMNormType> norms);
 
  SystemNorm(std::vector<FEMNormType> norms,
             std::vector<Real> & weights);
 
  SystemNorm(std::vector<FEMNormType> norms,
             std::vector<std::vector<Real>> & weights);
 
  SystemNorm (const SystemNorm &) = default;
  SystemNorm (SystemNorm &&) = default;
  SystemNorm & operator= (const SystemNorm &) = default;
  SystemNorm & operator= (SystemNorm &&) = default;
  virtual ~SystemNorm() = default;
 
  bool is_discrete() const;
 
  Real calculate_norm(const std::vector<Real> & v);
 
  Real calculate_norm(const std::vector<Real> & v1,
                      const std::vector<Real> & v2);
 
  bool is_identity();
 
  FEMNormType type(unsigned int var) const;
 
  void set_type(unsigned int var, const FEMNormType & t);
 
  Real weight(unsigned int var) const;
 
  void set_weight(unsigned int var, Real w);
 
  void set_off_diagonal_weight(unsigned int i, unsigned int j, Real w);
 
  Real weight_sq(unsigned int var) const;
 
 
 
private:
  std::vector<FEMNormType> _norms;
 
  std::vector<Real> _weights;
  std::vector<Real> _weights_sq;
 
  std::vector<std::vector<Real>> _off_diagonal_weights;
};
 
} // namespace libMesh
 
#endif // LIBMESH_SYSTEM_NORM_H