/*
  Copyright 2022 SINTEF Digital, Mathematics and Cybernetics.
  Copyright 2023 INRIA
  
  This file is part of the Open Porous Media project (OPM).

  OPM is free software: you can redistribute it and/or modify
  it under the terms of the GNU General Public License as published by
  the Free Software Foundation, either version 3 of the License, or
  (at your option) any later version.

  OPM is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  GNU General Public License for more details.

  You should have received a copy of the GNU General Public License
  along with OPM.  If not, see <http://www.gnu.org/licenses/>.
*/
#ifndef DAMARIS_OUTPUT_MODULE_HPP
#define DAMARIS_OUTPUT_MODULE_HPP

#include <opm/simulators/utils/ParallelCommunication.hpp>

#include <map>
#include <string>

/*
    Below is the XML file for Damaris that is supported by Damaris.

    The entries in the map below will be filled by corresponding Damaris
    Keywords.
*/

namespace Opm::DamarisOutput {

// Initialize an XML file
std::string initDamarisXmlFile();
 
/**
*   Initialize Damaris by either:
*  1/ Filling in a templated XML file and storing it in the chosen directory (output directory)
*  2/ Reading a file specified by the environment variable FLOW_DAMARIS_XML_FILE 
*  
*/
void initializeDamaris(const Parallel::Communication comm, const int mpiRank,
                       const std::map<std::string, std::string>& find_replace_map);

} // namespace Opm::DamarisOutput

#endif // DAMARIS_OUTPUT_MODULE_HPP