VectorMap.h

Go to the documentation of this file.

/*
 *  Copyright (c) 2012, Chris Rogers
 *  All rights reserved.
 *  Redistribution and use in source and binary forms, with or without
 *  modification, are permitted provided that the following conditions are met:
 *  1. Redistributions of source code must retain the above copyright notice,
 *     this list of conditions and the following disclaimer.
 *  2. 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.
 *  3. Neither the name of STFC 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 OWNER 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.
 */
 
#ifndef _OPALX_FIELDS_VECTORMAP_HH_
#define _OPALX_FIELDS_VECTORMAP_HH_
 
#include <vector>
 
#include "Fields/Interpolation/ThreeDGrid.h"
 
namespace interpolation {
 
    class VectorMap {
    public:
        virtual void function(const double* point, double* value) const = 0;
 
        inline virtual void function(const Mesh::Iterator& point, double* value) const;
 
        inline virtual void functionAppend(
                const std::vector<std::vector<double> >& point_vec,
                std::vector<std::vector<double> >& value_vec) const;
 
        inline virtual bool checkPoint(const std::vector<double>& point) const;
 
        inline virtual bool checkValue(const std::vector<double>& value) const;
 
        virtual unsigned int getPointDimension() const = 0;
        // would like to make static - but can't inherit static functions
 
        virtual unsigned int getValueDimension() const = 0;
        // would like to make static - but can't inherit static functions
 
        virtual VectorMap* clone() const = 0;
 
        virtual ~VectorMap() { ; }
 
        virtual Mesh* getMesh() const { return nullptr; }
 
    private:
    };
 
    bool VectorMap::checkPoint(const std::vector<double>& point) const {
        return (point.size() == this->getPointDimension());
    }
 
    bool VectorMap::checkValue(const std::vector<double>& value) const {
        return (value.size() == this->getValueDimension());
    }
 
    void VectorMap::function(const Mesh::Iterator& point, double* value) const {
        // Use standard C++ storage here; Clang warns on the VLA extension.
        std::vector<double> pointA(this->getPointDimension());
        point.getPosition(pointA.data());
        function(pointA.data(), value);
    }
 
    void VectorMap::functionAppend(
            const std::vector<std::vector<double> >& point_vec,
            std::vector<std::vector<double> >& value_vec) const {
        for (size_t i = value_vec.size(); i < point_vec.size(); i++) {
            value_vec.push_back(std::vector<double>(getValueDimension()));
            function(&point_vec[i][0], &value_vec[i][0]);
        }
    }
}  // namespace interpolation
#endif  // _OPALX_FIELDS_VECTORMAP_HH_