mirror of
https://github.com/OPM/opm-simulators.git
synced 2025-02-25 18:55:30 -06:00
64 lines
2.0 KiB
C++
64 lines
2.0 KiB
C++
/*
|
|
Copyright 2021 Equinor.
|
|
|
|
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 OPM_DAMARISKEYWORDS_HEADER_INCLUDED
|
|
#define OPM_DAMARISKEYWORDS_HEADER_INCLUDED
|
|
|
|
#include <string>
|
|
#include <map>
|
|
|
|
#include <mpi.h>
|
|
|
|
/*
|
|
Below is the std::map with the keywords that are supported by Damaris.
|
|
|
|
Most entries in the map below are not critical ('static') and will not
|
|
be changed. We only allow changing FileMode together with output directory
|
|
*/
|
|
|
|
|
|
namespace Opm::DamarisOutput
|
|
{
|
|
|
|
/**
|
|
* Returns true if the file exists.
|
|
* Tests to see if filename string is empty
|
|
* or the "#" character and if so returns false.
|
|
* Tests for file existance on ranl 0 and
|
|
* passes result via MPI to all other ranks.
|
|
*/
|
|
bool FileExists(const std::string filename_in, const MPI_Comm comm, const int rank) ;
|
|
|
|
|
|
/**
|
|
* Creates the map of search strings and repacement strings that will be used to
|
|
* modify a templated Damaris XML file which will be used to intialize Damaris.
|
|
* This function will access all the OPM flow comand line arguments related to
|
|
* Damaris and perform checks and logic so as to create a valid XML file.
|
|
* N.B. The created XML file can be overridden using an environment variable
|
|
* FLOW_DAMARIS_XML_FILE that points to a Damaris XML file.
|
|
*/
|
|
std::map<std::string, std::string>
|
|
DamarisKeywords(MPI_Comm comm, std::string OutputDir) ;
|
|
|
|
} // namespace Opm::DamarisOutput
|
|
|
|
|
|
#endif
|