PetscOutput.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 "Output.h"

class PetscOutput;

class PetscOutputInterface
{
public:
  PetscOutputInterface(PetscOutput * obj);

protected:
  PetscOutput * _petsc_output;

  static PetscErrorCode petscNonlinearOutput(SNES, PetscInt its, PetscReal fnorm, void * void_ptr);

  static PetscErrorCode petscLinearOutput(KSP, PetscInt its, PetscReal fnorm, void * void_ptr);
};

class PetscOutput : public Output, public PetscOutputInterface
{
public:
  static InputParameters validParams();

  PetscOutput(const InputParameters & parameters);

  virtual Real time() override;

protected:
  bool inNonlinearTimeWindow()
  {
    return _time >= _nonlinear_start_time - _t_tol && _time <= _nonlinear_end_time + _t_tol;
  }
  bool inLinearTimeWindow()
  {
    return _time >= _linear_start_time - _t_tol && _time <= _linear_end_time + _t_tol;
  }
  virtual Real getOutputTime();

  Real _norm;

  PetscInt _nonlinear_iter;

  PetscInt _linear_iter;

  bool _on_linear_residual;

  bool _on_nonlinear_residual;

private:
  void solveSetup() override;

  Real _nonlinear_time;

  Real _nonlinear_dt;

  Real _linear_time;

  Real _linear_dt;

  Real _nonlinear_dt_divisor;

  Real _linear_dt_divisor;

  Real _nonlinear_start_time;

  Real _linear_start_time;

  Real _nonlinear_end_time;

  Real _linear_end_time;

  friend class PetscOutputInterface;
};