GAS_IntegrateShallowWaterEquations.h

Go to the documentation of this file.

/*
 * PROPRIETARY INFORMATION.  This software is proprietary to
 * Side Effects Software Inc., and is not to be reproduced,
 * transmitted, or disclosed in any way without written permission.
 *
 * NAME:    GAS_IntegrateShallowWaterEquations.h ( GAS Library, C++)
 *
 * COMMENTS:
 *  Integrates the shallow water equations (without the velocity's advective
 *  part).
 */

#ifndef __GAS_IntegrateShallowWaterEquations__
#define __GAS_IntegrateShallowWaterEquations__

#include "GAS_SubSolver.h"
#include "GAS_Utils.h"

class GAS_API GAS_IntegrateShallowWaterEquations : public GAS_SubSolver
{
public:
    GET_DATA_FUNC_S(GAS_NAME_VELOCITY, VelocityName);
    GET_DATA_FUNC_S("depth", DepthName);
    GET_DATA_FUNC_S("bottom", BottomName);

    GET_DATA_FUNC_F("gravity", Gravity);
    GET_DATA_FUNC_F("veldiffusion", VelDiffusion);
    GET_DATA_FUNC_B("clampvel", ClampVelocities);
    GET_DATA_FUNC_F("maxvel", MaximumVelocity);
    
    GET_DATA_FUNC_B("usesource", UseSource);
    GET_DATA_FUNC_F("sourcescale", SourceScale);
    GET_DATA_FUNC_S("source", SourceName);
    GET_DATA_FUNC_B("sourceadd", AdditiveSource);
    GET_DATA_FUNC_B("usesink", UseSink);
    GET_DATA_FUNC_S("sink", SinkName);
    GET_DATA_FUNC_F("depthdiffusion", DepthDiffusion);
    GET_DATA_FUNC_B("clampsurfvel", ClampSurfaceVel);
    GET_DATA_FUNC_F("maxsurfvel", MaximumSurfaceVel);

    GET_DATA_FUNC_B("dampdepth", DampDepth);
    GET_DATA_FUNC_F("dampinglayer", DampingLayerSize);
    GET_DATA_FUNC_F("dampingstrength", DampingLayerStrength);
    GET_DATA_FUNC_B("dampaxis1m", DampAxis1M);
    GET_DATA_FUNC_B("dampaxis1p", DampAxis1P);
    GET_DATA_FUNC_B("dampaxis2m", DampAxis2M);
    GET_DATA_FUNC_B("dampaxis2p", DampAxis2P);

    GET_DATA_FUNC_B(GAS_NAME_USETIMESTEP, UseTimestep);
    GET_DATA_FUNC_F(GAS_NAME_TIMESCALE, TimeScale);

protected:
    explicit GAS_IntegrateShallowWaterEquations(const SIM_DataFactory* factory);
            ~GAS_IntegrateShallowWaterEquations() override;

    bool solveGasSubclass(SIM_Engine& engine,
                          SIM_Object* obj,
                          SIM_Time time,
                          SIM_Time timestep) override;

    bool integrateVelocity(SIM_Object* obj,
                           const SIM_ScalarField* depth,
                           const SIM_ScalarField* bottom,
                           SIM_VectorField* vel,
                           float dt,
                           int axis_2d) const;
    bool integrateDepth(SIM_Object* obj,
                        SIM_ScalarField* depth,
                        const SIM_VectorField* vel,
                        float dt,
                        int axis_2d) const;
    bool dampenInLayer(SIM_Object* obj,
                       SIM_ScalarField* depth,
                       SIM_VectorField* vel,
                       float dt,
                       int axis_2d) const;

private:
    static const SIM_DopDescription* getDopDescription();

    DECLARE_STANDARD_GETCASTTOTYPE();
    DECLARE_DATAFACTORY(GAS_IntegrateShallowWaterEquations,
                        GAS_SubSolver,
                        "Gas Integrate Shallow Water Equations",
                        getDopDescription());
};

#endif