auryn_global.h

Go to the documentation of this file.

/* 
* Copyright 2014-2018 Friedemann Zenke
*
* This file is part of Auryn, a simulation package for plastic
* spiking neural networks.
* 
* Auryn 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.
* 
* Auryn 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 Auryn.  If not, see <http://www.gnu.org/licenses/>.
*
* If you are using Auryn or parts of it for your work please cite:
* Zenke, F. and Gerstner, W., 2014. Limits to high-speed simulations 
* of spiking neural networks using general-purpose computers. 
* Front Neuroinform 8, 76. doi: 10.3389/fninf.2014.00076
*/

#ifndef AURYN_GLOBAL_H_
#define AURYN_GLOBAL_H_

#include <boost/filesystem.hpp>
#include "auryn_definitions.h"
#include "Logger.h"
#include "System.h"

// Global variables that are exported here.

namespace auryn {

        extern System * sys;

        extern Logger * logger;

#ifdef AURYN_CODE_USE_MPI

        extern mpi::environment * mpienv;

        extern mpi::communicator * mpicommunicator;
#endif // AURYN_CODE_USE_MPI


        void auryn_init(int ac, char* av[], string dir=".", string simulation_name="default", string logfile_prefix="", LogMessageType filelog_level=NOTIFICATION, LogMessageType consolelog_level=PROGRESS);

        void auryn_env_init(int ac, char* av[], string dir=".", string logfile_prefix="", LogMessageType filelog_level=NOTIFICATION, LogMessageType consolelog_level=PROGRESS);

        void auryn_kernel_init(string dir=".", string simulation_name="default");

        void auryn_free();

        void auryn_env_free();

        void auryn_kernel_free();

        void auryn_abort(int errcode=0); 
}

#endif /*AURYN_GLOBAL_H__*/