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

#ifndef __GAS_FieldVex__
#define __GAS_FieldVex__

#include "SIMZ_API.h"

#include <GU/GU_Detail.h>

#include <SIM/SIM_RawField.h>
#include <SIM/SIM_RawIndexField.h>
#include <SIM/SIM_PhysicalParms.h>

#include <CVEX/CVEX_Context.h>
#include <CVEX/CVEX_Value.h>

#include <GAS/GAS_SubSolver.h>
#include <OP/OP_Version.h>

class SIM_ScalarField;
class SIM_VectorField;
class SIM_MatrixField;
class SIM_IndexField;

class SIMZ_API GAS_FieldVex : public GAS_SubSolver
{
public:
    OP_VERSION                   versionParms() const { return myVersion; }
    void                         setVersionParms(OP_VERSION version) { myVersion = version; }

    GETSET_DATA_FUNCS_B("vex_multithread", MultiThread);
    GETSET_DATA_FUNCS_S("vexscript", VexScript);
    GETSET_DATA_FUNCS_S("vex_stencil", VexStencil);
    GETSET_DATA_FUNCS_S("bindings", Bindings);
    GETSET_DATA_FUNCS_B("autobind", Autobind);
    GETSET_DATA_FUNCS_S("inputbindings", InputBindings);
    GETSET_DATA_FUNCS_S("vex_cwdpath", VexCWD);
    GETSET_DATA_FUNCS_S("vex_outputmask", VexOutputMask);
    GETSET_DATA_FUNCS_B(GAS_NAME_USETIMESTEP, UseTimeStep);
    GETSET_DATA_FUNCS_F(GAS_NAME_TIMESCALE, TimeScale);
    GETSET_DATA_FUNCS_S("vex_precision", VexPrecision);

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

    void                 makeEqualSubclass(const SIM_Data *source) override;

    bool                 shouldMultiThread(SIM_RawField *field) const 
                         { return field->field()->numTiles() > 1; }

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

private:
    static const SIM_DopDescription     *getDopDescription();
    OP_VERSION                  myVersion;

    DECLARE_STANDARD_GETCASTTOTYPE();
    DECLARE_DATAFACTORY(GAS_FieldVex,
                        GAS_SubSolver,
                        "Gas Field Vex",
                        getDopDescription());
};

#endif