lock_object.h

Go to the documentation of this file.

//    |  /           |
//    ' /   __| _` | __|  _ \   __|
//    . \  |   (   | |   (   |\__ `
//   _|\_\_|  \__,_|\__|\___/ ____/
//                   Multi-Physics
//
//  License:         BSD License
//                   Kratos default license: kratos/license.txt
//
//  Main authors:    Pooyan Dadvand
//                   Philipp Bucher (https://github.com/philbucher)
//
 
#pragma once
 
// System includes
#include <mutex>
 
// External includes
#ifdef KRATOS_SMP_OPENMP
#include <omp.h>
#endif
 
// Project includes
#include "includes/define.h"
 
 
namespace Kratos
{
 
 
 
class LockObject
{
public:
 
    LockObject() noexcept
    {
#ifdef KRATOS_SMP_OPENMP
        omp_init_lock(&mLock);
#endif
    }
 
    LockObject(LockObject const& rOther) = delete;
 
    ~LockObject() noexcept
    {
#ifdef KRATOS_SMP_OPENMP
        omp_destroy_lock(&mLock);
#endif
    }
 
 
    LockObject& operator=(LockObject const& rOther) = delete;
 
 
    inline void lock() const
    {
#ifdef KRATOS_SMP_CXX11
        mLock.lock();
#elif KRATOS_SMP_OPENMP
        omp_set_lock(&mLock);
#endif
    }
 
    KRATOS_DEPRECATED_MESSAGE("Please use lock instead")
    inline void SetLock() const
    {
        this->lock();
    }
 
    inline void unlock() const
    {
#ifdef KRATOS_SMP_CXX11
        mLock.unlock();
#elif KRATOS_SMP_OPENMP
        omp_unset_lock(&mLock);
#endif
    }
 
    KRATOS_DEPRECATED_MESSAGE("Please use unlock instead")
    inline void UnSetLock() const
    {
        this->unlock();
    }
 
    inline bool try_lock() const
    {
#ifdef KRATOS_SMP_CXX11
        return mLock.try_lock();
#elif KRATOS_SMP_OPENMP
        return omp_test_lock(&mLock);
#endif
        return true;
    }
 
 
private:
 
#ifdef KRATOS_SMP_CXX11
        mutable std::mutex mLock;
#elif KRATOS_SMP_OPENMP
        mutable omp_lock_t mLock;
#endif
 
 
}; // Class LockObject
 
 
 
}  // namespace Kratos.