vtkLagrangianParticle.h

Go to the documentation of this file.

/*=========================================================================

  Program:   Visualization Toolkit
  Module:    vtkLagrangianParticle.h

  Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
  All rights reserved.
  See Copyright.txt or http://www.kitware.com/Copyright.htm for details.

    This software is distributed WITHOUT ANY WARRANTY; without even
    the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
    PURPOSE.  See the above copyright notice for more information.

=========================================================================*/
#ifndef vtkLagrangianParticle_h
#define vtkLagrangianParticle_h

#include "vtkFiltersFlowPathsModule.h" // For export macro
#include "vtkSystemIncludes.h" // For PrintSelf signature and vtkType

class vtkDataSet;
class vtkPointData;

class VTKFILTERSFLOWPATHS_EXPORT vtkLagrangianParticle
{
public:

  typedef 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
  } ParticleTermination;

  typedef enum SurfaceInteraction
  {
    SURFACE_INTERACTION_NO_INTERACTION = 0,
    SURFACE_INTERACTION_TERMINATED,
    SURFACE_INTERACTION_BREAK,
    SURFACE_INTERACTION_BOUNCE,
    SURFACE_INTERACTION_PASS,
    SURFACE_INTERACTION_OTHER
  } SurfaceInteraction;

  vtkLagrangianParticle(int numberOfVariables, vtkIdType seedId, vtkIdType particleId,
    vtkIdType seedArrayTupleIndex, double integrationTime, vtkPointData* seedData);

  static vtkLagrangianParticle* NewInstance(int numberOfVariables, vtkIdType seedId,
    vtkIdType particleId, vtkIdType seedArrayTupleIndex, double integrationTime,
    vtkPointData* seedData, vtkIdType numberOfSteps, double previousIntegrationTime);

  vtkLagrangianParticle* NewParticle(vtkIdType particleId);

  vtkLagrangianParticle* CloneParticle();

  virtual ~vtkLagrangianParticle();


  inline double* GetPrevEquationVariables()
  {
    return this->PrevEquationVariables;
  }


  inline double* GetEquationVariables()
  {
    return this->EquationVariables;
  }


  inline double* GetNextEquationVariables()
  {
    return this->NextEquationVariables;
  }


  inline double* GetPrevPosition()
  {
    return this->PrevEquationVariables;
  }


  inline double* GetPosition()
  {
    return this->EquationVariables;
  }


  inline double* GetNextPosition()
  {
    return this->NextEquationVariables;
  }


  inline double* GetPrevVelocity()
  {
    return this->PrevVelocity;
  }


  inline double* GetVelocity()
  {
    return this->Velocity;
  }


  inline double* GetNextVelocity()
  {
    return this->NextVelocity;
  }


  inline double* GetPrevUserVariables()
  {
    return this->PrevUserVariables;
  }


  inline double* GetUserVariables()
  {
    return this->UserVariables;
  }


  inline double* GetNextUserVariables()
  {
    return this->NextUserVariables;
  }

  virtual void MoveToNextPosition();

  virtual vtkIdType GetId();


  virtual void SetParentId(vtkIdType parentId);
  virtual vtkIdType GetParentId();

  virtual vtkIdType GetSeedId();

  virtual vtkIdType GetSeedArrayTupleIndex();

  virtual int GetNumberOfVariables();

  virtual int GetNumberOfUserVariables();

  virtual vtkPointData* GetSeedData();

  vtkIdType GetLastCellId();

  vtkDataSet* GetLastDataSet();

  vtkIdType GetLastSurfaceCellId();

  vtkDataSet* GetLastSurfaceDataSet();

  void SetLastCell(vtkDataSet* dataset, vtkIdType cellId);

  void SetLastSurfaceCell(vtkDataSet* dataset, vtkIdType cellId);

  virtual vtkIdType GetNumberOfSteps();


  virtual void SetTermination(int termination);
  virtual int GetTermination();


  virtual void SetInteraction(int interaction);
  virtual int GetInteraction();


  virtual void SetUserFlag(int flag);
  virtual int GetUserFlag();


  virtual void SetPInsertPreviousPosition(bool val);
  virtual bool GetPInsertPreviousPosition();


  virtual void SetPManualShift(bool val);
  virtual bool GetPManualShift();

  virtual double& GetStepTimeRef();

  virtual double GetIntegrationTime();

  virtual double GetPrevIntegrationTime();

  virtual void SetIntegrationTime(double time);

  double GetPositionVectorMagnitude();

  virtual void PrintSelf(ostream& os, vtkIndent indent);

protected:

  vtkLagrangianParticle* NewInstance(int numberOfVariables,
    vtkIdType seedId, vtkIdType particleId, vtkIdType seedArrayTupleIndex,
    double integrationTime, vtkPointData* seedData);

  vtkLagrangianParticle(const vtkLagrangianParticle&); // Not implemented
  vtkLagrangianParticle(); // Not implemented
  void operator=(const vtkLagrangianParticle&); // Not implemented

  double* PrevEquationVariables;
  double* PrevVelocity;
  double* PrevUserVariables;

  double* EquationVariables;
  double* Velocity;
  double* UserVariables;

  double* NextEquationVariables;
  double* NextVelocity;
  double* NextUserVariables;

  vtkIdType Id;
  vtkIdType ParentId;
  vtkIdType SeedId;
  vtkIdType SeedArrayTupleIndex;
  vtkIdType NumberOfSteps;
  vtkPointData* SeedData;
  vtkDataSet* LastDataSet;
  vtkIdType LastCellId;
  double StepTime;
  double IntegrationTime;
  double PrevIntegrationTime;
  int Termination;
  int Interaction;
  int UserFlag;
  vtkDataSet* LastSurfaceDataSet;
  vtkIdType LastSurfaceCellId;
  int NumberOfVariables;

  // Parallel related flags
  bool PInsertPreviousPosition;
  bool PManualShift;
};

#endif
// VTK-HeaderTest-Exclude: vtkLagrangianParticle.h