MaterialOutputAction.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 "Action.h"
#include "MaterialData.h"
#include "FEProblemBase.h"

class MooseObjectAction;
class MaterialBase;

class MaterialOutputAction : public Action
{
public:
  static InputParameters validParams();

  MaterialOutputAction(const InputParameters & params);

  virtual void act() override;

  struct OutputMetaData
  {
    std::string _aux_kernel_name;
    std::string _index_symbols;
    std::vector<std::string> _param_names;
  };

protected:
  virtual std::vector<std::string> materialOutput(const std::string & property_name,
                                                  const MaterialBase & material,
                                                  bool get_names_only);

  std::vector<std::string> outputHelper(const OutputMetaData & metadata,
                                        const std::string & property_name,
                                        const std::string & var_name_base,
                                        const MaterialBase & material,
                                        bool get_names_only);

  template <typename T>
  bool hasProperty(const std::string & property_name);

  template <typename T>
  bool hasADProperty(const std::string & property_name);

  template <typename T>
  bool hasFunctorProperty(const std::string & property_name);

  InputParameters getParams(const std::string & type,
                            const std::string & property_name,
                            const std::string & variable_name,
                            const MaterialBase & material);

private:
  const MaterialData * _block_material_data;

  const MaterialData * _boundary_material_data;

  std::map<std::string, std::set<SubdomainID>> _block_variable_map;

  std::set<std::string> _material_variable_names;

  std::map<OutputName, std::set<std::string>> _material_variable_names_map;

  OutputWarehouse & _output_warehouse;

  const bool _output_only_on_timestep_end;
};

template <typename T>
bool
MaterialOutputAction::hasProperty(const std::string & property_name)
{
  if (_block_material_data->haveProperty<T>(property_name) ||
      _boundary_material_data->haveProperty<T>(property_name))
    return true;
  else
    return false;
}

template <typename T>
bool
MaterialOutputAction::hasADProperty(const std::string & property_name)
{
  if (_block_material_data->haveADProperty<T>(property_name) ||
      _boundary_material_data->haveADProperty<T>(property_name))
    return true;
  else
    return false;
}

template <typename T>
bool
MaterialOutputAction::hasFunctorProperty(const std::string & property_name)
{
  return _problem->hasFunctorWithType<T>(property_name, 0);
}