HDK_Sample::SIM_GasAdd Class Reference
#include <SIM_GasAdd.h>
Public Member Functions | |
| GET_DATA_FUNC_S (GAS_NAME_FIELDDEST, FieldDstName) | |
| GET_DATA_FUNC_S (GAS_NAME_FIELDSOURCE, FieldSrcName) | |
Protected Member Functions | |
| SIM_GasAdd (const SIM_DataFactory *factory) | |
| virtual | ~SIM_GasAdd () |
| bool | shouldMultiThread (const SIM_RawField *field) const |
| virtual bool | solveGasSubclass (SIM_Engine &engine, SIM_Object *obj, SIM_Time time, SIM_Time timestep) |
| THREADED_METHOD2 (SIM_GasAdd, shouldMultiThread(dst), addFields, SIM_RawField *, dst, const SIM_RawField *, src) | |
| void | addFieldsPartial (SIM_RawField *dst, const SIM_RawField *src, const UT_JobInfo &info) |
Detailed Description
A simple field manipulation class that will add fields together.- Examples:
Definition at line 38 of file SIM_GasAdd.h.
Constructor & Destructor Documentation
| SIM_GasAdd::SIM_GasAdd | ( | const SIM_DataFactory * | factory | ) | [explicit, protected] |
Standard constructor, note that BaseClass was crated by the DECLARE_DATAFACTORY and provides an easy way to chain through the class hierarchy.
- Examples:
- SIM/SIM_GasAdd.h.
Definition at line 56 of file SIM_GasAdd.C.
| SIM_GasAdd::~SIM_GasAdd | ( | ) | [protected, virtual] |
Member Function Documentation
| void SIM_GasAdd::addFieldsPartial | ( | SIM_RawField * | dst, | |
| const SIM_RawField * | src, | |||
| const UT_JobInfo & | info | |||
| ) | [protected] |
| HDK_Sample::SIM_GasAdd::GET_DATA_FUNC_S | ( | GAS_NAME_FIELDSOURCE | , | |
| FieldSrcName | ||||
| ) |
| HDK_Sample::SIM_GasAdd::GET_DATA_FUNC_S | ( | GAS_NAME_FIELDDEST | , | |
| FieldDstName | ||||
| ) |
These macros are used to create the accessors getFieldDstName and getFieldSrcName functions we'll use to access our data options.
- Examples:
- SIM/SIM_GasAdd.h.
| bool HDK_Sample::SIM_GasAdd::shouldMultiThread | ( | const SIM_RawField * | field | ) | const [inline, protected] |
Used to determine if the field is complicated enough to justify the overhead of multithreading.
- Examples:
- SIM/SIM_GasAdd.h.
Definition at line 53 of file SIM_GasAdd.h.
| bool SIM_GasAdd::solveGasSubclass | ( | SIM_Engine & | engine, | |
| SIM_Object * | obj, | |||
| SIM_Time | time, | |||
| SIM_Time | timestep | |||
| ) | [protected, virtual] |
The overloaded callback that GAS_SubSolver will invoke to perform our actual computation. We are giving a single object at a time to work on.
Implements GAS_SubSolver.
- Examples:
- SIM/SIM_GasAdd.C, and SIM/SIM_GasAdd.h.
Definition at line 91 of file SIM_GasAdd.C.
| HDK_Sample::SIM_GasAdd::THREADED_METHOD2 | ( | SIM_GasAdd | , | |
| shouldMultiThread(dst) | , | |||
| addFields | , | |||
| SIM_RawField * | , | |||
| dst | , | |||
| const SIM_RawField * | , | |||
| src | ||||
| ) | [protected] |
Add two raw fields together. Use UT_ThreadedAlgorithm's macros to define the addFields method that will invoke addFieldPartial() on each worker thread.
- Examples:
- SIM/SIM_GasAdd.h.
The documentation for this class was generated from the following files:
- samples/SIM/SIM_GasAdd.h
- samples/SIM/SIM_GasAdd.C
