vp_manager.h

Go to the documentation of this file.

/*
 *  vp_manager.h
 *
 *  This file is part of NEST.
 *
 *  Copyright (C) 2004 The NEST Initiative
 *
 *  NEST 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 2 of the License, or
 *  (at your option) any later version.
 *
 *  NEST 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 NEST.  If not, see <http://www.gnu.org/licenses/>.
 *
 */
 
#ifndef VP_MANAGER_H
#define VP_MANAGER_H
 
// Includes from libnestutil:
#include "manager_interface.h"
 
// Includes from nestkernel:
#include "nest_types.h"
 
 
#ifdef _OPENMP
// C includes:
#include <omp.h>
#endif
 
namespace nest
{
 
struct AssignedRanks
{
  size_t begin;
  size_t end;
  size_t size;
  size_t max_size;
};
 
class VPManager : public ManagerInterface
{
public:
  VPManager();
  ~VPManager() override
  {
  }
 
  void initialize( const bool ) override;
  void finalize( const bool ) override;
 
  virtual void set_status( const Dictionary& ) override;
  virtual void get_status( Dictionary& ) override;
 
  size_t get_thread_id() const;
 
  void set_num_threads( const size_t n_threads );
 
  size_t get_num_threads() const;
 
  size_t get_OMP_NUM_THREADS() const;
 
  bool is_node_id_vp_local( const size_t node_id ) const;
 
  size_t node_id_to_lid( const size_t node_id ) const;
 
  size_t lid_to_node_id( const size_t lid ) const;
 
  size_t get_vp() const;
 
  size_t node_id_to_vp( const size_t node_id ) const;
 
  size_t vp_to_thread( const size_t vp ) const;
 
  size_t thread_to_vp( const size_t tid ) const;
 
  bool is_local_vp( const size_t tid ) const;
 
  size_t get_num_virtual_processes() const;
 
  void assert_single_threaded() const;
 
  void assert_thread_parallel() const;
 
  size_t get_num_assigned_ranks_per_thread() const;
 
  size_t get_start_rank_per_thread( const size_t tid ) const;
  size_t get_end_rank_per_thread( const size_t rank_start, const size_t num_assigned_ranks_per_thread ) const;
 
  AssignedRanks get_assigned_ranks( const size_t tid );
 
private:
  const bool force_singlethreading_;
  size_t n_threads_;  
};
 
inline size_t
VPManager::get_thread_id() const
{
#ifdef _OPENMP
  return omp_get_thread_num();
#else
  return 0;
#endif
}
 
inline size_t
VPManager::get_num_threads() const
{
  return n_threads_;
}
 
inline void
VPManager::assert_single_threaded() const
{
#ifdef _OPENMP
  assert( omp_get_num_threads() == 1 );
#endif
}
 
inline void
VPManager::assert_thread_parallel() const
{
#ifdef _OPENMP
  // omp_get_num_threads() returns int
  assert( omp_get_num_threads() == static_cast< int >( n_threads_ ) );
#endif
}
 
}  // namespace nest
 
#endif /* #ifndef VP_MANAGER_H */