|
| enum | ParticleTermination {
PARTICLE_TERMINATION_NOT_TERMINATED = 0,
PARTICLE_TERMINATION_SURF_TERMINATED,
PARTICLE_TERMINATION_FLIGHT_TERMINATED,
PARTICLE_TERMINATION_SURF_BREAK,
PARTICLE_TERMINATION_OUT_OF_DOMAIN,
PARTICLE_TERMINATION_OUT_OF_STEPS,
PARTICLE_TERMINATION_OUT_OF_TIME
} |
| | An enum to inform about a reason for termination PARTICLE_TERMINATION_NOT_TERMINATED = 0, means the particle have not yet been terminated PARTICLE_TERMINATION_SURF_TERMINATED = 1, means the particle have been terminated during a surface interaction PARTICLE_TERMINATION_FLIGHT_TERMINATED = 2, means the particle have been terminated by the model during a FreeFlightCheck() call PARTICLE_TERMINATION_SURF_BREAK = 3, means the particle have been terminated during a surface interaction by a break, meaning new particles have been created from it. More...
|
| |
| enum | SurfaceInteraction {
SURFACE_INTERACTION_NO_INTERACTION = 0,
SURFACE_INTERACTION_TERMINATED,
SURFACE_INTERACTION_BREAK,
SURFACE_INTERACTION_BOUNCE,
SURFACE_INTERACTION_PASS,
SURFACE_INTERACTION_OTHER
} |
| | An enum to inform about a surface interaction SURFACE_INTERACTION_NO_INTERACTION = 0, no interaction have taken place SURFACE_INTERACTION_TERMINATED = 1, a particle was terminated on interaction SURFACE_INTERACTION_BREAK = 2, a particle broke on interaction, hence terminating it and creating new particles from it SURFACE_INTERACTION_BOUNCE = 3, a particle bounced on interaction SURFACE_INTERACTION_PASS = 4, a particle passed through the surface, hence having no effect on the particle but actually recording it going through SURFACE_INTERACTION_OTHER = 5, another type of undefined interaction happened. More...
|
| |
| typedef enum vtkLagrangianParticle::ParticleTermination | ParticleTermination |
| | An enum to inform about a reason for termination PARTICLE_TERMINATION_NOT_TERMINATED = 0, means the particle have not yet been terminated PARTICLE_TERMINATION_SURF_TERMINATED = 1, means the particle have been terminated during a surface interaction PARTICLE_TERMINATION_FLIGHT_TERMINATED = 2, means the particle have been terminated by the model during a FreeFlightCheck() call PARTICLE_TERMINATION_SURF_BREAK = 3, means the particle have been terminated during a surface interaction by a break, meaning new particles have been created from it. More...
|
| |
| typedef enum vtkLagrangianParticle::SurfaceInteraction | SurfaceInteraction |
| | An enum to inform about a surface interaction SURFACE_INTERACTION_NO_INTERACTION = 0, no interaction have taken place SURFACE_INTERACTION_TERMINATED = 1, a particle was terminated on interaction SURFACE_INTERACTION_BREAK = 2, a particle broke on interaction, hence terminating it and creating new particles from it SURFACE_INTERACTION_BOUNCE = 3, a particle bounced on interaction SURFACE_INTERACTION_PASS = 4, a particle passed through the surface, hence having no effect on the particle but actually recording it going through SURFACE_INTERACTION_OTHER = 5, another type of undefined interaction happened. More...
|
| |
|
| | vtkLagrangianParticle (int numberOfVariables, vtkIdType seedId, vtkIdType particleId, vtkIdType seedArrayTupleIndex, double integrationTime, vtkPointData *seedData) |
| | Constructor to create a particle from a seed. More...
|
| |
| vtkLagrangianParticle * | NewParticle (vtkIdType particleId) |
| | method to create a particle from a parent particle. More...
|
| |
| vtkLagrangianParticle * | CloneParticle () |
| | method to create an exact clone of a particle. More...
|
| |
| virtual | ~vtkLagrangianParticle () |
| | Destructor. More...
|
| |
| double * | GetPrevEquationVariables () |
| | Get a pointer to Particle variables at its previous position See GetEquationVariables for content description. More...
|
| |
| double * | GetEquationVariables () |
| | Get a pointer to the particle variables array. More...
|
| |
| double * | GetNextEquationVariables () |
| | Get a pointer to the particle variables array at its next position. More...
|
| |
| double * | GetPrevPosition () |
| | Get a pointer to the previous particle position. More...
|
| |
| double * | GetPosition () |
| | Get a pointer to the particle position. More...
|
| |
| double * | GetNextPosition () |
| | Get a pointer to the next particle position. More...
|
| |
| double * | GetPrevVelocity () |
| | Get a pointer to the previous particle velocity. More...
|
| |
| double * | GetVelocity () |
| | Get a pointer to the particle velocity. More...
|
| |
| double * | GetNextVelocity () |
| | Get a pointer to the next particle velocity. More...
|
| |
| double * | GetPrevUserVariables () |
| | Get a pointer to the previous user variables. More...
|
| |
| double * | GetUserVariables () |
| | Get a pointer to the user variables. More...
|
| |
| double * | GetNextUserVariables () |
| | Get a pointer to the next user variables. More...
|
| |
| virtual void | MoveToNextPosition () |
| | Move the particle to its next position by putting next equation variable to equation variable and clearing next equation variable. More...
|
| |
| virtual vtkIdType | GetId () |
| | Get particle id. More...
|
| |
| virtual void | SetParentId (vtkIdType parentId) |
| | Set/Get parent particle id. More...
|
| |
| virtual vtkIdType | GetParentId () |
| |
| virtual vtkIdType | GetSeedId () |
| | Get the particle original seed index in the seed dataset. More...
|
| |
| virtual vtkIdType | GetSeedArrayTupleIndex () |
| | Get the particle data tuple in a seed array. More...
|
| |
| virtual int | GetNumberOfVariables () |
| | Get the number of variables used to initialize EquationVariables. More...
|
| |
| virtual int | GetNumberOfUserVariables () |
| | Get the number of variables specific to the user. More...
|
| |
| virtual vtkPointData * | GetSeedData () |
| | Get the particle data. More...
|
| |
| vtkIdType | GetLastCellId () |
| | Get the last traversed cell id. More...
|
| |
| vtkDataSet * | GetLastDataSet () |
| | Get the dataset containing the last traversed cell. More...
|
| |
| vtkIdType | GetLastSurfaceCellId () |
| | Get the last intersected surface cell id. More...
|
| |
| vtkDataSet * | GetLastSurfaceDataSet () |
| | Get the dataset containing the last intersected surface cell. More...
|
| |
| void | SetLastCell (vtkDataSet *dataset, vtkIdType cellId) |
| | Set the last dataset and last cell id. More...
|
| |
| void | SetLastSurfaceCell (vtkDataSet *dataset, vtkIdType cellId) |
| | Set the last surface dataset and last surface cell id. More...
|
| |
| virtual vtkIdType | GetNumberOfSteps () |
| | Get particle current number of steps. More...
|
| |
| virtual void | SetTermination (int termination) |
| | Set/Get particle termination. More...
|
| |
| virtual int | GetTermination () |
| |
| virtual void | SetInteraction (int interaction) |
| | Set/Get particle interaction. More...
|
| |
| virtual int | GetInteraction () |
| |
| virtual void | SetUserFlag (int flag) |
| | Set/Get user flag. More...
|
| |
| virtual int | GetUserFlag () |
| |
| virtual void | SetPInsertPreviousPosition (bool val) |
| | Set/Get parallel specific flag, indication to insert or not the previous position after streaming. More...
|
| |
| virtual bool | GetPInsertPreviousPosition () |
| |
| virtual void | SetPManualShift (bool val) |
| | Set/Get parallel specific flag, indication that the particle may be manually shifted after streaming. More...
|
| |
| virtual bool | GetPManualShift () |
| |
| virtual double & | GetStepTimeRef () |
| | Get reference to step time of this particle. More...
|
| |
| virtual double | GetIntegrationTime () |
| | Get the integration time. More...
|
| |
| virtual double | GetPrevIntegrationTime () |
| | Get the integration time at previous position. More...
|
| |
| virtual void | SetIntegrationTime (double time) |
| | Convenience setter for integration time, do not use unless manual particle shifting One using this method may want to consider modifying EquationVariable[numVals] which contain integrationTime as well, if it matters in their model. More...
|
| |
| double | GetPositionVectorMagnitude () |
| | Compute and return the position vector magnitude. More...
|
| |
| virtual void | PrintSelf (ostream &os, vtkIndent indent) |
| | Print information about the particle. More...
|
| |
Basis class for Lagrangian particles.
Particle to inject and integrate in the vtkLagrangianParticleTracker. This class does NOT inherit from vtkObject in order to increase performance and reduce memory usage.
- See also
- vtkLagrangianParticleTracker vtkLagrangianBasicIntegrationModel vtkLagrangianMatidaIntegrationModel
- Tests:
- vtkLagrangianParticle (Tests)
Definition at line 41 of file vtkLagrangianParticle.h.
An enum to inform about a reason for termination PARTICLE_TERMINATION_NOT_TERMINATED = 0, means the particle have not yet been terminated PARTICLE_TERMINATION_SURF_TERMINATED = 1, means the particle have been terminated during a surface interaction PARTICLE_TERMINATION_FLIGHT_TERMINATED = 2, means the particle have been terminated by the model during a FreeFlightCheck() call PARTICLE_TERMINATION_SURF_BREAK = 3, means the particle have been terminated during a surface interaction by a break, meaning new particles have been created from it.
PARTICLE_TERMINATION_OUT_OF_DOMAIN = 4, means the particle was terminated when going out of domain, if the surface is watertight this should not happen. PARTICLE_TERMINATION_OUT_OF_STEPS = 5, means the particle was terminated because maximum number of steps was reached PARTICLE_TERMINATION_OUT_OF_TIME = 6, means the particle was terminated because maximum integration time was reached
An enum to inform about a reason for termination PARTICLE_TERMINATION_NOT_TERMINATED = 0, means the particle have not yet been terminated PARTICLE_TERMINATION_SURF_TERMINATED = 1, means the particle have been terminated during a surface interaction PARTICLE_TERMINATION_FLIGHT_TERMINATED = 2, means the particle have been terminated by the model during a FreeFlightCheck() call PARTICLE_TERMINATION_SURF_BREAK = 3, means the particle have been terminated during a surface interaction by a break, meaning new particles have been created from it.
PARTICLE_TERMINATION_OUT_OF_DOMAIN = 4, means the particle was terminated when going out of domain, if the surface is watertight this should not happen. PARTICLE_TERMINATION_OUT_OF_STEPS = 5, means the particle was terminated because maximum number of steps was reached PARTICLE_TERMINATION_OUT_OF_TIME = 6, means the particle was terminated because maximum integration time was reached
| Enumerator |
|---|
| PARTICLE_TERMINATION_NOT_TERMINATED | |
| PARTICLE_TERMINATION_SURF_TERMINATED | |
| PARTICLE_TERMINATION_FLIGHT_TERMINATED | |
| PARTICLE_TERMINATION_SURF_BREAK | |
| PARTICLE_TERMINATION_OUT_OF_DOMAIN | |
| PARTICLE_TERMINATION_OUT_OF_STEPS | |
| PARTICLE_TERMINATION_OUT_OF_TIME | |
Definition at line 61 of file vtkLagrangianParticle.h.
An enum to inform about a surface interaction SURFACE_INTERACTION_NO_INTERACTION = 0, no interaction have taken place SURFACE_INTERACTION_TERMINATED = 1, a particle was terminated on interaction SURFACE_INTERACTION_BREAK = 2, a particle broke on interaction, hence terminating it and creating new particles from it SURFACE_INTERACTION_BOUNCE = 3, a particle bounced on interaction SURFACE_INTERACTION_PASS = 4, a particle passed through the surface, hence having no effect on the particle but actually recording it going through SURFACE_INTERACTION_OTHER = 5, another type of undefined interaction happened.
| Enumerator |
|---|
| SURFACE_INTERACTION_NO_INTERACTION | |
| SURFACE_INTERACTION_TERMINATED | |
| SURFACE_INTERACTION_BREAK | |
| SURFACE_INTERACTION_BOUNCE | |
| SURFACE_INTERACTION_PASS | |
| SURFACE_INTERACTION_OTHER | |
Definition at line 81 of file vtkLagrangianParticle.h.
