Interpolator3dGridTo1d.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_INTERPOLATOR3DGRIDTO1D_H_
#define _OPALX_FIELDS_INTERPOLATOR3DGRIDTO1D_H_
 
#include "Fields/Interpolation/ThreeDGrid.h"
#include "Fields/Interpolation/VectorMap.h"
 
namespace interpolation {
 
    class Interpolator3dGridTo1d : public VectorMap {
    public:
        inline Interpolator3dGridTo1d(ThreeDGrid* grid, double*** F);
 
        inline Interpolator3dGridTo1d();
 
        inline virtual ~Interpolator3dGridTo1d();
 
        inline virtual void function(const Mesh::Iterator& point, double* value) const {
            VectorMap::function(point, value);
        }
 
        virtual void function(const double Point[3], double Value[1]) const = 0;
 
        virtual Interpolator3dGridTo1d* clone() const = 0;
 
        inline int getNumberOfXCoords() const;
 
        inline int getNumberOfYCoords() const;
 
        inline int getNumberOfZCoords() const;
 
        inline unsigned int getPointDimension() const;
 
        inline unsigned int getValueDimension() const;
 
        inline ThreeDGrid* getMesh() const;
 
        inline void setGrid(ThreeDGrid* grid);
 
        inline void setX(int nCoords, double* x);
 
        inline void setY(int nCoords, double* y);
 
        inline void setZ(int nCoords, double* z);
 
        inline void setF(double*** inF);
 
        void deleteFunc(double*** func);
 
        inline double*** function() const;
 
        inline void setAll(ThreeDGrid* grid, double*** F);
 
        inline void clear();
 
    protected:
        ThreeDGrid* coordinates_m;
        double*** f_m;
    };
 
    Interpolator3dGridTo1d::Interpolator3dGridTo1d(ThreeDGrid* grid, double*** F)
        : coordinates_m(nullptr), f_m(nullptr) {
        setAll(grid, F);
    }
 
    Interpolator3dGridTo1d::Interpolator3dGridTo1d() : coordinates_m(nullptr), f_m(nullptr) {}
 
    Interpolator3dGridTo1d::~Interpolator3dGridTo1d() { clear(); }
 
    int Interpolator3dGridTo1d::getNumberOfXCoords() const { return coordinates_m->xSize(); }
 
    int Interpolator3dGridTo1d::getNumberOfYCoords() const { return coordinates_m->ySize(); }
 
    int Interpolator3dGridTo1d::getNumberOfZCoords() const { return coordinates_m->zSize(); }
 
    unsigned int Interpolator3dGridTo1d::getPointDimension() const { return 3; }
 
    unsigned int Interpolator3dGridTo1d::getValueDimension() const { return 1; }
 
    ThreeDGrid* Interpolator3dGridTo1d::getMesh() const { return coordinates_m; }
 
    void Interpolator3dGridTo1d::setF(double*** inF) {
        deleteFunc(f_m);
        f_m = inF;
    }
 
    void Interpolator3dGridTo1d::setGrid(ThreeDGrid* grid) {
        if (coordinates_m != nullptr) coordinates_m->remove(this);
        grid->add(this);
        coordinates_m = grid;
    }
 
    void Interpolator3dGridTo1d::setX(int nCoords, double* x) {
        if (coordinates_m != nullptr) coordinates_m->setX(nCoords, x);
    }
 
    void Interpolator3dGridTo1d::setY(int nCoords, double* y) {
        if (coordinates_m != nullptr) coordinates_m->setY(nCoords, y);
    }
 
    void Interpolator3dGridTo1d::setZ(int nCoords, double* z) {
        if (coordinates_m != nullptr) coordinates_m->setZ(nCoords, z);
    }
 
    double*** Interpolator3dGridTo1d::function() const { return f_m; }
 
    void Interpolator3dGridTo1d::setAll(ThreeDGrid* grid, double*** F) {
        setGrid(grid);
        setF(F);
    }
 
    void Interpolator3dGridTo1d::clear() {
        deleteFunc(f_m);
        coordinates_m->remove(this);
    }
 
}  // namespace interpolation
#endif  // _OPALX_FIELDS_INTERPOLATOR3DGRIDTO1D_HH_