parametermanager.h

Go to the documentation of this file.

/*
 *
 *                 #####    #####   ######  ######  ###   ###
 *               ##   ##  ##   ##  ##      ##      ## ### ##
 *              ##   ##  ##   ##  ####    ####    ##  #  ##
 *             ##   ##  ##   ##  ##      ##      ##     ##
 *            ##   ##  ##   ##  ##      ##      ##     ##
 *            #####    #####   ##      ######  ##     ##
 *
 *
 *             OOFEM : Object Oriented Finite Element Code
 *
 *               Copyright (C) 1993 - 2025   Borek Patzak
 *
 *
 *
 *       Czech Technical University, Faculty of Civil Engineering,
 *   Department of Structural Mechanics, 166 29 Prague, Czech Republic
 *
 *  This library is free software; you can redistribute it and/or
 *  modify it under the terms of the GNU Lesser General Public
 *  License as published by the Free Software Foundation; either
 *  version 2.1 of the License, or (at your option) any later version.
 *
 *  This program 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
 *  Lesser General Public License for more details.
 *
 *  You should have received a copy of the GNU Lesser General Public
 *  License along with this library; if not, write to the Free Software
 *  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 */
 
#ifndef parametermanager_h
#define parametermanager_h
 
#include <unordered_map>
#include <string>
#include <tuple>
#include <vector>
#include <mutex>
#include <shared_mutex>
#include <variant>
#include <optional>
 
#include "intarray.h"
#include "floatarray.h"
#include "floatmatrix.h"
 
#include "error.h"
 
namespace oofem {
 
 
#define PM_UPDATE_PARAMETER(_val, _pm, _ir, _componentnum, _paramkey, _prio) \
    { \
        std::size_t _indx=_paramkey.getIndex(); \
        const char* _kwd = _paramkey.getName().c_str(); \
        if ((_prio >= _pm.getPriority(_componentnum, _indx)) && (_ir.hasField(_kwd))) { \
            _ir.giveField(_val, _kwd); \
            _pm.setPriority(_componentnum, _indx, _prio); \
        } \
    }
 
#define PM_UPDATE_PARAMETER_AND_REPORT(_val, _pm, _ir, _componentnum, _paramkey, _prio, _flag) \
    { \
        std::size_t _indx=_paramkey.getIndex(); \
        const char* _kwd = _paramkey.getName().c_str(); \
        if ((_prio >= _pm.getPriority(_componentnum, _indx)) && (_ir.hasField(_kwd))) { \
            _ir.giveField(_val, _kwd); \
            _pm.setPriority(_componentnum, _indx, _prio); \
            _flag=true; \
        } else { \
            _flag=false; \
        } \
    }
 
#define PM_UPDATE_TEMP_PARAMETER(_type, _pm, _ir, _componentnum, _paramkey, _prio) \
    { \
        std::size_t _indx=_paramkey.getIndex(); \
        const char* _kwd = _paramkey.getName().c_str(); \
        if ((_prio >= _pm.getPriority(_componentnum, _indx)) && (_ir.hasField(_kwd))) { \
            _type _val; \
            _ir.giveField(_val, _kwd); \
            _pm.setPriority(_componentnum, _indx, _prio); \
            _pm.setTemParam(_componentnum, _indx, _val); \
        } \
    }
 
#define PM_CHECK_FLAG_AND_REPORT(_pm, _ir, _componentnum, _paramkey, _prio, _flag) \
    { \
        std::size_t _indx=_paramkey.getIndex(); \
        const char* _kwd = _paramkey.getName().c_str(); \
        if ((_prio >= _pm.getPriority(_componentnum, _indx)) && (_ir.hasField(_kwd))) { \
            _pm.setPriority(_componentnum, _indx, _prio); \
            _flag=true; \
        } else { \
            _flag=false; \
        } \
    }
 
#define PM_ELEMENT_ERROR_IFNOTSET(_pm, _componentnum, _paramkey) \
    { \
        if (!_pm.checkIfSet(_componentnum, _paramkey.getIndex())) { \
            OOFEM_ERROR("Element %d: Parameter %s not set", _componentnum, _paramkey.getNameCStr());\
        }\
    }    
 
#define PM_DOFMAN_ERROR_IFNOTSET(_pm, _componentnum, _paramkey) \
    { \
        if (!_pm.checkIfSet(_componentnum, _paramkey.getIndex())) { \
            OOFEM_ERROR("DofManager %d: Parameter %s not set", _componentnum, _paramkey.getNameCStr());\
        }\
    }    

// ParameterManager class to track parameter priorities
class ParameterManager {
public:
    using paramValue = std::variant<int, double, std::string, bool, IntArray, FloatArray, FloatMatrix>;
    void setPriority(size_t componentIndex, size_t paramIndex, int priority) {
        std::unique_lock lock(mtx);
        if (componentIndex > priorities.size()) {
            priorities.resize(componentIndex);
        }
        priorities[componentIndex-1][paramIndex] = priority;
    }
 
    int getPriority(size_t componentIndex, size_t paramIndex) const {
        std::shared_lock lock(mtx);
        int ci1 = componentIndex - 1; // Adjust for 0-based index
        if (componentIndex <= priorities.size() && priorities[ci1].find(paramIndex) != priorities[ci1].end()) {
            return priorities[ci1].at(paramIndex);
        }
        return -1; // Return -1 if priority is not found
    }
 
    void clear() {
        std::unique_lock lock(mtx);
        priorities.clear();
        tempParams.clear();
    }
 
    bool checkIfSet(size_t componentIndex, size_t paramIndex) {
        int ci1 = componentIndex - 1; // Adjust for 0-based index 
        if (componentIndex <= priorities.size()) {      
            return priorities[ci1].find(paramIndex) != priorities[ci1].end();
        } else {
            return false; // Return false if componentIndex is out of bounds
        }
    }
 
    void setTemParam(size_t componentIndex, size_t paramIndex, const paramValue &value) {
        std::unique_lock lock(mtx);
        if (componentIndex >= tempParams.size()) {
            tempParams.resize(componentIndex);
        }
        tempParams[componentIndex-1][paramIndex] = value;
    }
    std::optional<paramValue> getTempParam(size_t componentIndex, size_t paramIndex) const {
        std::shared_lock lock(mtx);
        int ci1 = componentIndex - 1; // Adjust for 0-based index
        auto it = tempParams[ci1].find(paramIndex);
        if (it != tempParams[ci1].end()) {
            return it->second;
        }
        return std::nullopt; // Return nullopt if parameter is not found
    }
    bool hasTempParam(size_t componentIndex, size_t paramIndex) const {
        std::shared_lock lock(mtx);
        int ci1 = componentIndex - 1; // Adjust for 0-based index
        return tempParams[ci1].find(paramIndex) != tempParams[ci1].end();
    }
 
private:
    std::vector<std::unordered_map<size_t, int>> priorities;
    mutable std::shared_mutex mtx;
 
    std::vector<std::unordered_map<size_t, paramValue>> tempParams;
};
 
 
 
 
} // end namespace oofem
 
 
#endif // parametermanager_h