MFEMDataCollection.C

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

#ifdef MOOSE_MFEM_ENABLED

#include "MFEMDataCollection.h"

InputParameters
MFEMDataCollection::validParams()
{
  InputParameters params = FileOutput::validParams();
  params.addClassDescription("Output for controlling MFEMDataCollection inherited data.");
  params.addParam<std::string>("submesh",
                               "Submesh to output variables on. Leave blank to use base mesh.");
  params.addParam<std::vector<VariableName>>(
      "show", {}, "A list of variables that should be included in the collection.");
  params.addParam<std::vector<VariableName>>(
      "hide", {}, "A list of variables that should NOT be included in the collection.");
  return params;
}

MFEMDataCollection::MFEMDataCollection(const InputParameters & parameters)
  : FileOutput(parameters),
    _problem_data(static_cast<MFEMProblem *>(_problem_ptr)->getProblemData()),
    _pmesh(parameters.isParamValid("submesh")
               ? _problem_data.submeshes.GetRef(getParam<std::string>("submesh"))
               : const_cast<mfem::ParMesh &>(*_problem_data.pmesh.get())),
    _shown(getParam<std::vector<VariableName>>("show")),
    _hidden(getParam<std::vector<VariableName>>("hide"))
{
}

void
MFEMDataCollection::registerFields()
{
  // Save real fields
  mfem::DataCollection & dc(getDataCollection());

  for (auto const & [gf_name, gf_ptr] : _problem_data.gridfunctions)
  {
    if ((_shown.size() && std::find(_shown.begin(), _shown.end(), gf_name) == _shown.end()) ||
        std::find(_hidden.begin(), _hidden.end(), gf_name) != _hidden.end())
      continue;
    else if (dc.GetMesh() == gf_ptr->FESpace()->GetMesh())
      dc.RegisterField(gf_name, gf_ptr.get());
    else
      mooseInfo("The variable ",
                gf_name,
                " is not defined on the same mesh as the output DataCollection.");
  }

  // Save complex fields
  for (auto const & [gf_name, gf_ptr] : _problem_data.cmplx_gridfunctions)
  {
    if ((_shown.size() && std::find(_shown.begin(), _shown.end(), gf_name) == _shown.end()) ||
        std::find(_hidden.begin(), _hidden.end(), gf_name) != _hidden.end())
      continue;
    else if (dc.GetMesh() == gf_ptr->FESpace()->GetMesh())
    {
      dc.RegisterField(gf_name + "_real", &gf_ptr->real());
      dc.RegisterField(gf_name + "_imag", &gf_ptr->imag());
    }
    else
      mooseInfo("The variable ",
                gf_name,
                " is not defined on the same mesh as the output DataCollection.");
  }
}

void
MFEMDataCollection::setFileBaseInternal(const std::string & file_base)
{
  FileOutput::setFileBaseInternal(file_base);
  getDataCollection().SetPrefixPath(_file_base);
}

void
MFEMDataCollection::output()
{
  mfem::DataCollection & dc(getDataCollection());
  // Write fields to disk
  dc.SetCycle(getFileNumber());
  dc.SetTime(time());
  dc.Save();
  ++_file_num;
}

#endif