Interpolator3dGridTo3d.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_INTERPOLATOR3DGRIDTO3D_HH_
#define _OPALX_FIELDS_INTERPOLATOR3DGRIDTO3D_HH_
 
#include "Fields/Interpolation/Interpolator3dGridTo1d.h"
#include "Fields/Interpolation/Mesh.h"
#include "Fields/Interpolation/TriLinearInterpolator.h"
#include "Fields/Interpolation/VectorMap.h"
 
namespace interpolation {
 
    class Interpolator3dGridTo3d : public VectorMap {
    public:
        enum interpolationAlgorithm { TRILINEAR };
 
        inline Interpolator3dGridTo3d(
                ThreeDGrid* grid, double*** Bx, double*** By, double*** Bz,
                interpolationAlgorithm algo = TRILINEAR);
 
        Interpolator3dGridTo3d(const Interpolator3dGridTo3d& interpolator);
 
        ~Interpolator3dGridTo3d() { clear(); }
 
        Interpolator3dGridTo3d* clone() const { return new Interpolator3dGridTo3d(*this); }
 
        void function(const double Point[3], double Value[3]) const;
 
        inline virtual void function(const Mesh::Iterator& point, double* value) const {
            VectorMap::function(point, value);
        }
 
        void functionPrime(const double Point[3], double Value[3], int axis) const;
 
        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);
 
        void setAll(
                ThreeDGrid* grid, double*** Bx, double*** By, double*** Bz,
                interpolationAlgorithm algo = TRILINEAR);
 
        inline void clear();
 
    protected:
        ThreeDGrid* coordinates_m;
        Interpolator3dGridTo1d* interpolator_m[3];
    };
 
    int Interpolator3dGridTo3d::getNumberOfXCoords() const { return coordinates_m->xSize(); }
 
    int Interpolator3dGridTo3d::getNumberOfYCoords() const { return coordinates_m->ySize(); }
 
    int Interpolator3dGridTo3d::getNumberOfZCoords() const { return coordinates_m->zSize(); }
 
    unsigned int Interpolator3dGridTo3d::getPointDimension() const { return 3; }
 
    unsigned int Interpolator3dGridTo3d::getValueDimension() const { return 3; }
 
    ThreeDGrid* Interpolator3dGridTo3d::getMesh() const { return coordinates_m; }
 
    void Interpolator3dGridTo3d::setGrid(ThreeDGrid* grid) {
        if (coordinates_m != nullptr) coordinates_m->remove(this);
        grid->add(this);
        coordinates_m = grid;
    }
 
    void Interpolator3dGridTo3d::setX(int nCoords, double* x) {
        if (coordinates_m != nullptr) coordinates_m->setX(nCoords, x);
    }
 
    void Interpolator3dGridTo3d::setY(int nCoords, double* y) {
        if (coordinates_m != nullptr) coordinates_m->setY(nCoords, y);
    }
 
    void Interpolator3dGridTo3d::setZ(int nCoords, double* z) {
        if (coordinates_m != nullptr) coordinates_m->setZ(nCoords, z);
    }
 
    inline Interpolator3dGridTo3d::Interpolator3dGridTo3d(
            ThreeDGrid* grid, double*** Bx, double*** By, double*** Bz,
            interpolationAlgorithm /*algo*/)
        : coordinates_m(nullptr) {
        for (int i = 0; i < 3; i++)
            interpolator_m[i] = nullptr;
        setAll(grid, Bx, By, Bz);
    }
 
    void Interpolator3dGridTo3d::clear() {
        for (int i = 0; i < 3; i++)
            delete interpolator_m[i];
        coordinates_m->remove(this);
    }
 
}  // namespace interpolation
 
#endif