examples/smpi/MM/param.h

   1 #ifndef param_H_
   2 #define param_H_
   3
   4 #include <stdio.h>
   5
   6 /*!
   7  * \page param Provide specific parameters to some processes
   8  * List of functions:
   9  * - get_conf - reads a file and returns the specific parameters for the process
  10  * - print_conf - prints the file for the platform used for this execution
  11  *
  12  * here an examples of file:
  13  *
  14  * \include utils/param_template_file.txt
  15  *
  16  * each process will get the list of arguments specific to its.
  17  *
  18  * for example, the process 3<sup>th</sup> on the node1 will receive a pointer
  19  * on an array of char*:
  20  *
  21  *
  22  *  "node1" "2" "node1_arg21" "node1_arg22" "node1_arg2"
  23  */
  24
  25 /*! reads a file and returns the specific parameters for the process */
  26 char** get_conf(MPI_Comm comm, const char * filename, int mynoderank);
  27
  28 /*! reads a file and returns the parameters of every processes */
  29 char*** get_conf_all(char * filename, int * nb_process);
  30
  31
  32 /*! prints the file for the platform used for this execution */
  33 void print_conf(MPI_Comm comm, int rank, FILE* file, char * default_options);
  34
  35 #endif /*param_H_*/