PetscOutputInterface Class Reference

#include <PetscOutput.h>

Inheritance diagram for PetscOutputInterface:

Public Member Functions
	PetscOutputInterface (PetscOutput *obj)

Static Protected Member Functions
static PetscErrorCode	petscNonlinearOutput (SNES, PetscInt its, PetscReal fnorm, void *void_ptr)
	Performs the output on non-linear iterations This is the monitor method that PETSc will call on non-linear iterations.
static PetscErrorCode	petscLinearOutput (KSP, PetscInt its, PetscReal fnorm, void *void_ptr)
	Performs the output onlinear iterations This is the monitor method that PETSc will call on linear iterations.

Protected Attributes
PetscOutput *	_petsc_output

Detailed Description

Definition at line 17 of file PetscOutput.h.

Constructor & Destructor Documentation

PetscOutputInterface()

PetscOutputInterface::PetscOutputInterface

(

PetscOutput *

obj

)

Definition at line 19 of file PetscOutput.C.

                                                            : _petsc_output(obj)
{
  // register petsc output interface
  obj->getMooseApp().registerInterfaceObject(*this);
}

Member Function Documentation

petscLinearOutput()

PetscErrorCode PetscOutputInterface::petscLinearOutput ( KSP  , PetscInt  its, PetscReal  fnorm, void *  void_ptr  )

staticprotected

Performs the output onlinear iterations This is the monitor method that PETSc will call on linear iterations.

This is one of three locations where we explicitly flush the output buffers during a simulation: PetscOutput::petscNonlinearOutput() PetscOutput::petscLinearOutput() OutputWarehouse::outputStep()

All other Console output should be using newlines to avoid covering buffer errors and to avoid excessive I/O. This call is necessary. In the PETSc callback the context bypasses the OutputWarehouse.

Definition at line 76 of file PetscOutput.C.

{
  // Get the primary outputter object
  PetscOutput * primary_ptr = static_cast<PetscOutput *>(void_ptr);
 
  // loop over all interface objects
  for (const auto poi_ptr : primary_ptr->getMooseApp().getInterfaceObjects<PetscOutputInterface>())
  {
    auto ptr = poi_ptr->_petsc_output;
 
    // check time
    if (!ptr->inLinearTimeWindow())
      continue;
 
    // Update the pseudo time
    ptr->_linear_time += ptr->_linear_dt;
 
    // Set the current norm and iteration number
    ptr->_norm = norm;
    ptr->_linear_iter = its;
 
    // Set the flag indicating that output is occurring on the non-linear residual
    ptr->_on_linear_residual = true;
 
    // Perform the output
    ptr->outputStep(EXEC_LINEAR);
 
    ptr->_app.getOutputWarehouse().flushConsoleBuffer();
 
    // Reset the linear output flag and the simulation time
    ptr->_on_linear_residual = false;
  }
 
  // Done
  return (PetscErrorCode)0;
}

Referenced by PetscOutput::solveSetup().

petscNonlinearOutput()

PetscErrorCode PetscOutputInterface::petscNonlinearOutput ( SNES  , PetscInt  its, PetscReal  fnorm, void *  void_ptr  )

staticprotected

Performs the output on non-linear iterations This is the monitor method that PETSc will call on non-linear iterations.

This is one of three locations where we explicitly flush the output buffers during a simulation: PetscOutput::petscNonlinearOutput() PetscOutput::petscLinearOutput() OutputWarehouse::outputStep()

All other Console output should be using newlines to avoid covering buffer errors and to avoid excessive I/O. This call is necessary. In the PETSc callback the context bypasses the OutputWarehouse.

Definition at line 26 of file PetscOutput.C.

{
  // Get the primary outputter object
  PetscOutput * primary_ptr = static_cast<PetscOutput *>(void_ptr);
 
  // loop over all interface objects
  for (const auto poi_ptr : primary_ptr->getMooseApp().getInterfaceObjects<PetscOutputInterface>())
  {
    auto ptr = poi_ptr->_petsc_output;
 
    // check time
    if (!ptr->inNonlinearTimeWindow())
      continue;
 
    // Update the pseudo times
    ptr->_nonlinear_time += ptr->_nonlinear_dt;
    ptr->_linear_time = ptr->_nonlinear_time;
 
    // Set the current norm and iteration number
    ptr->_norm = norm;
    ptr->_nonlinear_iter = its;
 
    // Set the flag indicating that output is occurring on the non-linear residual
    ptr->_on_nonlinear_residual = true;
 
    // Perform the output
    ptr->outputStep(EXEC_NONLINEAR);
 
    ptr->_app.getOutputWarehouse().flushConsoleBuffer();
 
    // Reset the non-linear output flag and the simulation time
    ptr->_on_nonlinear_residual = false;
  }
 
  // Done
  return (PetscErrorCode)0;
}

Referenced by PetscOutput::solveSetup().

Member Data Documentation

_petsc_output

PetscOutput* PetscOutputInterface::_petsc_output

protected

Definition at line 23 of file PetscOutput.h.

Referenced by petscLinearOutput(), and petscNonlinearOutput().

---

The documentation for this class was generated from the following files:

• include/outputs/PetscOutput.h
• src/outputs/PetscOutput.C