IFEM-2/IFEM_8h_source.html

// $Id$

//==============================================================================

//==============================================================================


#ifndef _IFEM_H_

#define _IFEM_H_


#define IFEM_VERSION_STRING "2026.10-pre"


#include "SIMoptions.h"

#include "LogStream.h"


#ifndef NDEBUG

#include "ScopedLogger.h"

#define SCOPED_LOG ScopedLogger no_conflict_logger(__PRETTY_FUNCTION__);

#else

#define SCOPED_LOG

#endif


class ControlFIFO;

class ControlCallback;


class IFEM

{

public:

  static int Init(int arg_c, char** arg_v,

                  const char* title = nullptr, bool silent = false);

  static void Close();


  static void applyCommandLineOptions(SIMoptions& opt);

  static SIMoptions& getOptions() { return cmdOptions; }


  static void registerCallback(ControlCallback& cb);

  static bool pollControllerFifo();


  static utl::LogStream cout;


  static std::shared_ptr<std::ostringstream> memoryLog;


private:

  static SIMoptions cmdOptions;

  static int argc;

  static char** argv;

  static ControlFIFO* fifo;

};


#endif

LogStream.h
Log stream class.

SIMoptions.h
Class for encapsulation of general simulation options.

ScopedLogger.h
Scoped logger.

ControlCallback
Callback for FIFO option handling.
Definition ControlFIFO.h:28

ControlFIFO
This class enables simple application control over a FIFO.
Definition ControlFIFO.h:45

IFEM
Class holding global IFEM configuration.
Definition IFEM.h:39

IFEM::applyCommandLineOptions
static void applyCommandLineOptions(SIMoptions &opt)
Applies command-line argument values to the general input options.
Definition IFEM.C:204

IFEM::argv
static char ** argv
The command-line arguments.
Definition IFEM.h:69

IFEM::Close
static void Close()
Closes the IFEM library.
Definition IFEM.C:180

IFEM::cmdOptions
static SIMoptions cmdOptions
General input options.
Definition IFEM.h:67

IFEM::Init
static int Init(int arg_c, char **arg_v, const char *title=nullptr, bool silent=false)
Initializes the IFEM library.
Definition IFEM.C:41

IFEM::registerCallback
static void registerCallback(ControlCallback &cb)
Registers a fifo instruction callback.
Definition IFEM.C:189

IFEM::pollControllerFifo
static bool pollControllerFifo()
Polls the control fifo for instructions.
Definition IFEM.C:195

IFEM::memoryLog
static std::shared_ptr< std::ostringstream > memoryLog
Logging data stored in memory.
Definition IFEM.h:64

IFEM::cout
static utl::LogStream cout
Combined standard out for parallel processes.
Definition IFEM.h:62

IFEM::fifo
static ControlFIFO * fifo
Control fifo helper.
Definition IFEM.h:70

IFEM::argc
static int argc
The number of command-line arguments.
Definition IFEM.h:68

IFEM::getOptions
static SIMoptions & getOptions()
Returns a reference to the general input options.
Definition IFEM.h:55

SIMoptions
Class for encapsulation of general simulation options.
Definition SIMoptions.h:37

utl::LogStream
Logging stream class.
Definition LogStream.h:26