VectorMemoryUsage.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

#include "GeneralVectorPostprocessor.h"
#include "MemoryUsageReporter.h"
#include "MemoryUtils.h"

class VectorMemoryUsage : public GeneralVectorPostprocessor, public MemoryUsageReporter
{
public:
  static InputParameters validParams();

  VectorMemoryUsage(const InputParameters & parameters);

  virtual void timestepSetup() override;

  virtual void initialize() override {}
  virtual void execute() override;
  virtual void finalize() override;

protected:
  MemoryUtils::MemUnits _mem_units;

  VectorPostprocessorValue & _col_hardware_id;

  VectorPostprocessorValue & _col_total_ram;

  VectorPostprocessorValue & _col_physical_mem;

  VectorPostprocessorValue & _col_virtual_mem;

  VectorPostprocessorValue & _col_page_faults;

  VectorPostprocessorValue & _col_node_utilization;

  const bool _report_peak_value;
  Real _peak_physical_mem;
  Real _peak_virtual_mem;
};