sfield.h

Go to the documentation of this file.

/********************************************************************************************************************************************
 * Saras
 * 
 * Copyright (C) 2019, Mahendra K. Verma
 *
 * 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 the copyright holder 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 HOLDER 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 SFIELD_H
#define SFIELD_H
 
#include "field.h"
#include "derivative.h"
 
// Forward declarations of relevant classes
class plainsf;
class plainvf;
class vfield;
 
class sfield {
    private:
        const grid &gridData;
 
        blitz::Array<real, 3> derivTempF;
 
    public:
        field F;
 
        derivative derS;
 
        std::string fieldName;
 
        blitz::Array<real, 3> interTempF;
 
        sfield(const grid &gridData, std::string fieldName);
 
        void computeDiff(plainsf &H);
        void computeNLin(const vfield &V, plainsf &H);
 
        void gradient(plainvf &gradF, const vfield &V);
 
        void syncData();
 
        sfield& operator += (plainsf &a);
        sfield& operator -= (plainsf &a);
 
        sfield& operator += (sfield &a);
        sfield& operator -= (sfield &a);
 
        sfield& operator *= (real a);
 
        void operator = (plainsf &a);
        void operator = (sfield &a);
        void operator = (real a);
 
        ~sfield() { };
};
 
#endif