GAS_AdvectCL-2.0.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_AdvectCL-2.0.h ( GAS Library, C++)
 *
 * COMMENTS:
 */

#ifndef __GAS_AdvectCL_2_0__
#define __GAS_AdvectCL_2_0__

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

class GAS_API GAS_AdvectCL2 : public GAS_SubSolver
{
public:
    GET_DATA_FUNC_S(GAS_NAME_FIELDDEST, FieldDstName);
    GET_DATA_FUNC_S(GAS_NAME_VELOCITY, VelocityName);
    GET_DATA_FUNC_I("advectscheme", AdvectScheme);
    GET_DATA_FUNC_I("clampvalues", ClampingMode);
    GET_DATA_FUNC_F("blendwidth", Blendwidth);
    GET_DATA_FUNC_I("tracemethod", TraceMethod);
    GET_DATA_FUNC_B("usecfl", UseCFL);
    GET_DATA_FUNC_F("cflcond", CFLCond);
    GET_DATA_FUNC_I("maxbatchsize", MaxBatchSize);
    GET_DATA_FUNC_B(GAS_NAME_USETIMESTEP, UseTimestep);
    GET_DATA_FUNC_F(GAS_NAME_TIMESCALE, TimeScale);
    GET_DATA_FUNC_V3("wind", Wind);

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

    explicit GAS_AdvectCL2(const SIM_DataFactory* factory);
            ~GAS_AdvectCL2() override;

private:
    static const SIM_DopDescription* getDopDescription();

    DECLARE_STANDARD_GETCASTTOTYPE();
    DECLARE_DATAFACTORY(GAS_AdvectCL2,
                        GAS_SubSolver,
                        "Gas Advect CL",
                        getDopDescription());
};

#endif