INSADObjectTracker.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 "GeneralUserObject.h"
#include "MooseTypes.h"
#include "MooseEnum.h"
#include "MooseError.h"
#include "InputParameters.h"

#include "libmesh/vector_value.h"

#include <unordered_map>
#include <set>

template <typename>
class ADMaterialProperty;
template <typename>
class MaterialProperty;

void addAmbientConvectionParams(InputParameters & params);

class INSADObjectTracker : public GeneralUserObject
{
public:
  static InputParameters validParams();

  INSADObjectTracker(const InputParameters & parameters);

  template <typename T>
  void set(const std::string & name, const T & value, SubdomainID sub_id);

  template <typename T>
  const T & get(const std::string & name, SubdomainID sub_id) const;

  virtual void initialize() final {}
  virtual void execute() final {}
  virtual void finalize() final {}

  bool isTrackerParamValid(const std::string & name, SubdomainID sub_id) const;

  void addBlockIDs(const std::set<SubdomainID> & additional_block_ids);

private:
  template <typename T>
  static bool notEqual(const T & val1, const T & val2);

  std::unordered_map<SubdomainID, InputParameters> _block_id_to_params;

  static InputParameters validTrackerParams();

  template <typename T>
  static void set(const std::string & name, const T & value, InputParameters & params);

  const InputParameters & getParams(SubdomainID sub_id) const;
};

template <typename T>
bool
INSADObjectTracker::notEqual(const T & val1, const T & val2)
{
  return val1 != val2;
}

template <>
bool INSADObjectTracker::notEqual(const MooseEnum & val1, const MooseEnum & val2);

template <typename T>
void
INSADObjectTracker::set(const std::string & name, const T & value, InputParameters & params)
{
  if (params.isParamSetByUser(name))
  {
    const T & current_value = params.get<T>(name);
    if (INSADObjectTracker::notEqual(current_value, value))
      ::mooseError("Two INSADObjects set different values for the parameter ", name);
  }
  else if (!params.have_parameter<T>(name))
    ::mooseError("Attempting to set parameter ", name, " that is not a valid param");
  else
    params.set<T>(name) = value;
}

template <typename T>
void
INSADObjectTracker::set(const std::string & name, const T & value, const SubdomainID sub_id)
{
  INSADObjectTracker::set(name, value, const_cast<InputParameters &>(getParams(sub_id)));
}

template <typename T>
const T &
INSADObjectTracker::get(const std::string & name, const SubdomainID sub_id) const
{
  const InputParameters & params = getParams(sub_id);

  if (!params.isParamValid(name))
    mooseError("The parameter ", name, " is being retrieved before being set");

  return params.get<T>(name);
}