AdvancedOutputUtils.h

Go to the documentation of this file.

//* This file is part of the MOOSE framework
//* https://www.mooseframework.org
//*
//* 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 "MooseError.h"
#include "ExecFlagEnum.h"

// Forward declarations
class InputParameters;

struct OutputData
{
  std::set<std::string> available;

  std::set<std::string> show;

  std::set<std::string> hide;

  std::set<std::string> output;

  void reset();
};

template <typename T>
class OutputMapWrapper
{
public:
  OutputMapWrapper(){};

  T & operator[](const std::string & name)
  {
    // Locate the map entry, error if it is not found
    typename std::map<std::string, T>::iterator iter = _map.find(name);
    if (iter == _map.end())
      mooseError("Unknown map key ", name);
    return iter->second;
  }


  typename std::map<std::string, T>::iterator begin() { return _map.begin(); }
  typename std::map<std::string, T>::iterator end() { return _map.end(); }
  typename std::map<std::string, T>::iterator find(const std::string & name)
  {
    return _map.find(name);
  }
  typename std::map<std::string, T>::const_iterator begin() const { return _map.begin(); }
  typename std::map<std::string, T>::const_iterator end() const { return _map.end(); }
  const typename std::map<std::string, T>::const_iterator find(const std::string & name) const
  {
    return _map.find(name);
  }

  bool contains(const std::string & name) const { return find(name) != end(); }

protected:
  typename std::map<std::string, T> _map;
};

class OutputOnWarehouse : public OutputMapWrapper<ExecFlagEnum>
{
public:
  OutputOnWarehouse(const ExecFlagEnum & execute_on, const InputParameters & parameters);
};

class OutputDataWarehouse : public OutputMapWrapper<OutputData>
{
public:
  static InputParameters validParams();

  OutputDataWarehouse();

  bool hasShowList() { return _has_show_list; }

  void setHasShowList(bool value) { _has_show_list = value; }

  void reset();

private:
  // True when the input file contains a show/hide list
  bool _has_show_list;
};