Mesh.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.
 */
 
#include <ostream>
#include <vector>
 
#ifndef _OPALX_FIELDS_MESH_H_
#define _OPALX_FIELDS_MESH_H_
 
namespace interpolation {
 
    class VectorMap;
 
    class Mesh {
    public:
        class Iterator;
 
        inline Mesh();
        virtual Mesh::Iterator begin() const = 0;
 
        virtual Mesh::Iterator end() const = 0;
 
        virtual Mesh* clone() = 0;
 
        virtual Mesh* dual() const = 0;
 
        inline virtual ~Mesh();
 
        virtual void getPosition(const Mesh::Iterator& it, double* position) const = 0;
 
        virtual int getPositionDimension() const = 0;
 
        virtual int toInteger(const Mesh::Iterator& lhs) const = 0;
 
        virtual Mesh::Iterator getNearest(const double* position) const = 0;
 
    protected:
        virtual Mesh::Iterator& addEquals(Mesh::Iterator& lhs, int difference) const = 0;
 
        virtual Mesh::Iterator& subEquals(Mesh::Iterator& lhs, int difference) const = 0;
 
        virtual Mesh::Iterator& addEquals(Mesh::Iterator& lhs, const Mesh::Iterator& rhs) const = 0;
 
        virtual Mesh::Iterator& subEquals(Mesh::Iterator& lhs, const Mesh::Iterator& rhs) const = 0;
 
        virtual Mesh::Iterator& addOne(Mesh::Iterator& lhs) const = 0;
 
        virtual Mesh::Iterator& subOne(Mesh::Iterator& lhs) const = 0;
 
        virtual bool isGreater(const Mesh::Iterator& lhs, const Mesh::Iterator& rhs) const = 0;
 
    public:
        // Iterator needs to know about internal workings of the Mesh to work
        // properly
        friend Mesh::Iterator operator++(Mesh::Iterator& lhs, int);
        friend Mesh::Iterator operator--(Mesh::Iterator& lhs, int);
        friend Mesh::Iterator& operator++(Mesh::Iterator& lhs);
        friend Mesh::Iterator& operator--(Mesh::Iterator& lhs);
        friend Mesh::Iterator operator-(const Mesh::Iterator& lhs, const Mesh::Iterator& rhs);
        friend Mesh::Iterator operator+(const Mesh::Iterator& lhs, const Mesh::Iterator& rhs);
        friend Mesh::Iterator& operator-=(Mesh::Iterator& lhs, const Mesh::Iterator& rhs);
        friend Mesh::Iterator& operator+=(Mesh::Iterator& lhs, const Mesh::Iterator& rhs);
        friend Mesh::Iterator operator-(const Mesh::Iterator& lhs, const int& rhs);
        friend Mesh::Iterator operator+(const Mesh::Iterator& lhs, const int& rhs);
        friend Mesh::Iterator& operator-=(Mesh::Iterator& lhs, const int& rhs);
        friend Mesh::Iterator& operator+=(Mesh::Iterator& lhs, const int& rhs);
 
        friend bool operator==(const Mesh::Iterator& lhs, const Mesh::Iterator& rhs);
        friend bool operator!=(const Mesh::Iterator& lhs, const Mesh::Iterator& rhs);
        friend bool operator>=(const Mesh::Iterator& lhs, const Mesh::Iterator& rhs);
        friend bool operator<=(const Mesh::Iterator& lhs, const Mesh::Iterator& rhs);
        friend bool operator<(const Mesh::Iterator& lhs, const Mesh::Iterator& rhs);
        friend bool operator>(const Mesh::Iterator& lhs, const Mesh::Iterator& rhs);
    };
 
    class Mesh::Iterator {
    public:
        inline Iterator();
 
        inline Iterator(const Mesh::Iterator& in);
 
        inline Iterator(std::vector<int> state, const Mesh* mesh);
 
        inline virtual ~Iterator();
 
        inline const Mesh::Iterator& operator=(const Mesh::Iterator& rhs);
 
        inline virtual void getPosition(double* point) const;
 
        inline virtual std::vector<double> getPosition() const;
 
        inline int toInteger() const;
 
        inline std::vector<int> getState() const;
 
        inline int& operator[](int i);
 
        inline const int& operator[](int i) const;
 
        inline const Mesh* getMesh() const;
 
        virtual inline bool isOutOfBounds() const;
 
        virtual inline void addState(const Mesh::Iterator& it);
 
        friend class Mesh;
        friend class ThreeDGrid;
        friend class NDGrid;
 
        friend Mesh::Iterator operator++(Mesh::Iterator& lhs, int);
        friend Mesh::Iterator operator--(Mesh::Iterator& lhs, int);
        friend Mesh::Iterator& operator++(Mesh::Iterator& lhs);
        friend Mesh::Iterator& operator--(Mesh::Iterator& lhs);
        friend Mesh::Iterator operator-(const Mesh::Iterator& lhs, const int& difference);
        friend Mesh::Iterator operator+(const Mesh::Iterator& lhs, const int& difference);
        friend Mesh::Iterator& operator-=(Mesh::Iterator& lhs, const int& difference);
        friend Mesh::Iterator& operator+=(Mesh::Iterator& lhs, const int& difference);
        friend Mesh::Iterator operator-(const Mesh::Iterator& lhs, const Mesh::Iterator& rhs);
        friend Mesh::Iterator operator+(const Mesh::Iterator& lhs, const Mesh::Iterator& rhs);
        friend Mesh::Iterator& operator-=(Mesh::Iterator& lhs, const Mesh::Iterator& rhs);
        friend Mesh::Iterator& operator+=(Mesh::Iterator& lhs, const Mesh::Iterator& rhs);
 
        friend bool operator==(const Mesh::Iterator& lhs, const Mesh::Iterator& rhs);
        friend bool operator!=(const Mesh::Iterator& lhs, const Mesh::Iterator& rhs);
        friend bool operator>=(const Mesh::Iterator& lhs, const Mesh::Iterator& rhs);
        friend bool operator<=(const Mesh::Iterator& lhs, const Mesh::Iterator& rhs);
        friend bool operator<(const Mesh::Iterator& lhs, const Mesh::Iterator& rhs);
        friend bool operator>(const Mesh::Iterator& lhs, const Mesh::Iterator& rhs);
 
    private:
        const Mesh* mesh_m;
        std::vector<int> state_m;
    };
 
    inline Mesh::Iterator& operator++(Mesh::Iterator& lhs);
 
    inline Mesh::Iterator& operator--(Mesh::Iterator& lhs);
 
    inline Mesh::Iterator operator++(Mesh::Iterator& lhs, int);
 
    inline Mesh::Iterator operator--(Mesh::Iterator& lhs, int);
 
    inline Mesh::Iterator operator-(const Mesh::Iterator& lhs, const Mesh::Iterator& rhs);
 
    inline Mesh::Iterator operator+(const Mesh::Iterator& lhs, const Mesh::Iterator& rhs);
 
    inline Mesh::Iterator& operator-=(Mesh::Iterator& lhs, const Mesh::Iterator& rhs);
 
    inline Mesh::Iterator& operator+=(Mesh::Iterator& lhs, const Mesh::Iterator& rhs);
 
    inline Mesh::Iterator operator-(const Mesh::Iterator& lhs, const int& rhs);
 
    inline Mesh::Iterator operator+(const Mesh::Iterator& lhs, const int& rhs);
 
    inline Mesh::Iterator& operator-=(Mesh::Iterator& lhs, const int& rhs);
 
    inline Mesh::Iterator& operator+=(Mesh::Iterator& lhs, const int& rhs);
 
    inline bool operator==(const Mesh::Iterator& lhs, const Mesh::Iterator& rhs);
 
    inline bool operator!=(const Mesh::Iterator& lhs, const Mesh::Iterator& rhs);
 
    inline bool operator>=(const Mesh::Iterator& lhs, const Mesh::Iterator& rhs);
 
    inline bool operator<=(const Mesh::Iterator& lhs, const Mesh::Iterator& rhs);
 
    inline bool operator<(const Mesh::Iterator& lhs, const Mesh::Iterator& rhs);
 
    inline bool operator>(const Mesh::Iterator& lhs, const Mesh::Iterator& rhs);
 
    std::ostream& operator<<(std::ostream& out, const Mesh::Iterator& it);
 
}  // namespace interpolation
 
#include "Fields/Interpolation/Mesh-inl.icc"
 
#endif