GAS_ReduceLocal Class Reference

#include <GAS_ReduceLocal.h>

Inheritance diagram for GAS_ReduceLocal:

GAS_SubSolver SIM_Solver SIM_OptionsUser SIM_Data

List of all members.

Public Types

enum  REDUCTION_NAMES {
  REDUCE_MAX = 0, REDUCE_MIN, REDUCE_AVERAGE, REDUCE_MEDIAN,
  REDUCE_SUM, REDUCE_SUMABS, REDUCE_SUMSQUARE, REDUCE_RMS,
  NUM_REDUCE
}

Public Member Functions

 GET_DATA_FUNC_S (GAS_NAME_FIELD, FieldName)
 GETSET_DATA_FUNCS_F ("radius", Radius)
 GETSET_DATA_FUNCS_V3 ("voxelradius", VoxelRadius)
 GET_DATA_FUNC_B ("usevoxelradius", UseVoxelRadius)
 GET_DATA_FUNC_I ("reduction", Reduce)
 GET_DATA_FUNC_F ("percentile", Percentile)
 GET_DATA_FUNC_I ("scaleby", ScaleBy)
 GET_DATA_FUNC_B (GAS_NAME_USETIMESTEP, UseTimeStep)
 GET_DATA_FUNC_F (GAS_NAME_TIMESCALE, TimeScale)
bool shouldMultiThread (UT_VoxelArrayF *field) const

Protected Member Functions

 GAS_ReduceLocal (const SIM_DataFactory *factory)
virtual ~GAS_ReduceLocal ()
virtual bool solveGasSubclass (SIM_Engine &engine, SIM_Object *obj, SIM_Time time, SIM_Time timestep)
void doReduction (SIM_RawField *field, SIM_Time timestep)


Detailed Description

Definition at line 35 of file GAS_ReduceLocal.h.


Member Enumeration Documentation

Enumerator:
REDUCE_MAX 
REDUCE_MIN 
REDUCE_AVERAGE 
REDUCE_MEDIAN 
REDUCE_SUM 
REDUCE_SUMABS 
REDUCE_SUMSQUARE 
REDUCE_RMS 
NUM_REDUCE 

Definition at line 50 of file GAS_ReduceLocal.h.


Constructor & Destructor Documentation

GAS_ReduceLocal::GAS_ReduceLocal ( const SIM_DataFactory factory  )  [explicit, protected]

virtual GAS_ReduceLocal::~GAS_ReduceLocal (  )  [protected, virtual]


Member Function Documentation

void GAS_ReduceLocal::doReduction ( SIM_RawField field,
SIM_Time  timestep 
) [protected]

GAS_ReduceLocal::GET_DATA_FUNC_B ( GAS_NAME_USETIMESTEP  ,
UseTimeStep   
)

GAS_ReduceLocal::GET_DATA_FUNC_B ( "usevoxelradius"  ,
UseVoxelRadius   
)

GAS_ReduceLocal::GET_DATA_FUNC_F ( GAS_NAME_TIMESCALE  ,
TimeScale   
)

GAS_ReduceLocal::GET_DATA_FUNC_F ( "percentile"  ,
Percentile   
)

GAS_ReduceLocal::GET_DATA_FUNC_I ( "scaleby"  ,
ScaleBy   
)

GAS_ReduceLocal::GET_DATA_FUNC_I ( "reduction"  ,
Reduce   
)

GAS_ReduceLocal::GET_DATA_FUNC_S ( GAS_NAME_FIELD  ,
FieldName   
)

GAS_ReduceLocal::GETSET_DATA_FUNCS_F ( "radius"  ,
Radius   
)

GAS_ReduceLocal::GETSET_DATA_FUNCS_V3 ( "voxelradius"  ,
VoxelRadius   
)

bool GAS_ReduceLocal::shouldMultiThread ( UT_VoxelArrayF field  )  const [inline]

Definition at line 62 of file GAS_ReduceLocal.h.

virtual bool GAS_ReduceLocal::solveGasSubclass ( SIM_Engine engine,
SIM_Object obj,
SIM_Time  time,
SIM_Time  timestep 
) [protected, virtual]

Reduces fields by gathering local windows and applying the reduction operator.

Implements GAS_SubSolver.


The documentation for this class was generated from the following file:

Generated on Mon Jan 28 00:48:12 2013 for HDK by  doxygen 1.5.9