CvodeContextManager.cpp

/*
 
Copyright (c) 2005-2026, University of Oxford.
All rights reserved.
 
University of Oxford means the Chancellor, Masters and Scholars of the
University of Oxford, having an administrative office at Wellington
Square, Oxford OX1 2JD, UK.
 
This file is part of Chaste.
 
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
 * Redistributions of source code must retain the above copyright notice,
   this list of conditions and the following disclaimer.
 * Redistributions in binary form must reproduce the above copyright notice,
   this list of conditions and the following disclaimer in the documentation
   and/or other materials provided with the distribution.
 * Neither the name of the University of Oxford nor the names of its
   contributors may be used to endorse or promote products derived from this
   software without specific prior written permission.
 
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
*/
 
#if CHASTE_SUNDIALS_VERSION >= 60000
#include <cassert>
#include <memory>
 
#include <nvector/nvector_serial.h>
#include <sundials/sundials_types.h> // For SUN_COMM_NULL
#include "CvodeContextManager.hpp"
 
CvodeContextManager::CvodeContextManager()
{
#if CHASTE_SUNDIALS_VERSION >= 70000
    SUNContext_Create(SUN_COMM_NULL, &mSundialsContext);
#else
    SUNContext_Create(NULL, &mSundialsContext);  //"a pointer to the MPI communicator or NULL if not using MPI"
#endif
}
 
CvodeContextManager::~CvodeContextManager()
{
    SUNContext_Free(&mSundialsContext);
}
 
std::shared_ptr<CvodeContextManager> CvodeContextManager::Instance()
{
    // Single instance per thread. Ownership is shared rather than exclusive because the
    // context has to outlive everything created against it: thread-local destructors run at
    // the start of exit(), before the destructors of static objects in shared libraries, and
    // some of those statics (e.g. CellCycleModelOdeSolver's mpInstance) still hold a
    // CvodeAdaptor whose destructor calls CVodeFree(). Freeing the context when the thread
    // goes away would therefore be a use-after-free at exit, which Sundials 7 detects via
    // SUNContext_PeekLastError. Note that make_shared cannot be used here as the constructor
    // is private.
    static thread_local std::shared_ptr<CvodeContextManager> p_instance(new CvodeContextManager());
    return p_instance;
}
 
SUNContext& CvodeContextManager::GetSundialsContext()
{
    assert(mSundialsContext);
    return mSundialsContext;
}
 
#endif // CHASTE_SUNDIALS_VERSION >= 60000