TopResidualDebugOutput.h

Go to the documentation of this file.

//* This file is part of the MOOSE framework
//* https://mooseframework.inl.gov
//*
//* All rights reserved, see COPYRIGHT for full restrictions
//* https://github.com/idaholab/moose/blob/master/COPYRIGHT
//*
//* Licensed under LGPL 2.1, please see LICENSE for details
//* https://www.gnu.org/licenses/lgpl-2.1.html

#pragma once

// MOOSE includes
#include "PetscOutput.h"

#include "libmesh/system.h"

class NonlinearSystemBase;

struct TopResidualDebugOutputTopResidualData
{
  unsigned int _var;
  std::set<SubdomainID> _subdomain_ids;
  dof_id_type _id;
  Point _point;
  Real _residual;
  bool _is_scalar;
  bool _is_nodal;

  TopResidualDebugOutputTopResidualData()
    : _var(0),
      _subdomain_ids(),
      _id(0),
      _point(Point()),
      _residual(0.),
      _is_scalar(false),
      _is_nodal(true)
  {
  }

  TopResidualDebugOutputTopResidualData(unsigned int var,
                                        std::set<SubdomainID> subdomain_ids,
                                        dof_id_type id,
                                        Point point,
                                        Real residual,
                                        bool is_scalar = false,
                                        bool is_nodal = true)
    : _var(var),
      _subdomain_ids(subdomain_ids),
      _id(id),
      _point(point),
      _residual(residual),
      _is_scalar(is_scalar),
      _is_nodal(is_nodal)
  {
  }
};

class TopResidualDebugOutput : public PetscOutput
{
public:
  static InputParameters validParams();

  TopResidualDebugOutput(const InputParameters & parameters);

protected:
  virtual void output() override;

  void printTopResiduals(const NumericVector<Number> & residual, unsigned int n);

  static bool sortTopResidualData(TopResidualDebugOutputTopResidualData i,
                                  TopResidualDebugOutputTopResidualData j)
  {
    return (fabs(i._residual) > fabs(j._residual));
  }

  unsigned int _num_residuals;

  NonlinearSystemBase & _nl;

  libMesh::System & _sys;
};