initializeEnvironment.hpp

/*
 * ------------------------------------------------------------------------------------------------------------
 * SPDX-License-Identifier: LGPL-2.1-only
 *
 * Copyright (c) 2016-2024 Lawrence Livermore National Security LLC
 * Copyright (c) 2018-2024 TotalEnergies
 * Copyright (c) 2018-2024 The Board of Trustees of the Leland Stanford Junior University
 * Copyright (c) 2023-2024 Chevron
 * Copyright (c) 2019-     GEOS/GEOSX Contributors
 * All rights reserved
 *
 * See top level LICENSE, COPYRIGHT, CONTRIBUTORS, NOTICE, and ACKNOWLEDGEMENTS files for details.
 * ------------------------------------------------------------------------------------------------------------
 */
 
#ifndef GEOS_COMMON_INITIALIZEENVIRONMENT_HPP_
#define GEOS_COMMON_INITIALIZEENVIRONMENT_HPP_
 
// Source includes
#include "DataTypes.hpp"
#include "MpiWrapper.hpp"
 
// TPL includes
#ifdef GEOS_USE_CALIPER
 
#ifdef GEOS_USE_ADIAK
#include <adiak.hpp>
#endif
 
//Forward declaration of cali::ConfigManager.
namespace cali
{
class ConfigManager;
}
#endif
 
namespace geos
{
 
struct CommandLineOptions
{
  string_array inputFileNames;
 
  bool beginFromRestart = false;
 
  string restartFileName;
 
  integer xPartitionsOverride;
 
  integer yPartitionsOverride;
 
  integer zPartitionsOverride;
 
  integer overridePartitionNumbers = false;
 
  integer useNonblockingMPI = false;
 
  integer suppressPinned = false;
 
  string schemaName;
 
  string problemName;
 
  string outputDirectory = ".";
 
  string timerOutput = "";
 
  integer traceDataMigration = false;
 
  real64 printMemoryUsage = -1.0;
};
 
void setupLogger();
 
void finalizeLogger();
 
void finalizeCaliper();
 
void setupLvArray();
 
void setupMKL();
 
void setupOpenMP();
 
void setupMPI( int argc, char * argv[] );
 
void finalizeMPI();
 
 
void setupEnvironment( int argc, char * argv[] );
 
void cleanupEnvironment();
 
#if defined( GEOS_USE_CALIPER )
 
void setupCaliper( cali::ConfigManager & caliperManager,
                   CommandLineOptions const & commandLineOptions );
 
 
#endif
 
template< typename T >
void pushStatsIntoAdiak( string const & name, T const value )
{
#if defined( GEOS_USE_CALIPER ) && defined( GEOS_USE_ADIAK ) && !defined(__APPLE__)
  // Apple clang doesn't like adiak.
  T const total = MpiWrapper::sum( value );
  adiak::value( name + " sum", total );
  adiak::value( name + " mean", double( total ) / MpiWrapper::commSize() );
  adiak::value( name + " min", MpiWrapper::min( value ) );
  adiak::value( name + " max", MpiWrapper::max( value ) );
#else
  GEOS_UNUSED_VAR( name );
  GEOS_UNUSED_VAR( value );
#endif
}
 
} // namespace geos
 
#endif // GEOS_COMMON_INITIALIZEENVIRONMENT_HPP_