VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes
vtkAMRGaussianPulseSource Class Reference

#include <vtkAMRGaussianPulseSource.h>

Inheritance diagram for vtkAMRGaussianPulseSource:
Inheritance graph
[legend]
Collaboration diagram for vtkAMRGaussianPulseSource:
Collaboration graph
[legend]

List of all members.

Public Types

typedef vtkOverlappingAMRAlgorithm Superclass

Public Member Functions

virtual int IsA (const char *type)
vtkAMRGaussianPulseSourceNewInstance () const
void PrintSelf (ostream &os, vtkIndent indent)
virtual void SetDimension (int)
virtual void SetNumberOfLevels (int)
void SetRefinementRatio (int r)
void SetRootSpacing (double h0)
virtual void SetPulseOrigin (double, double, double)
virtual void SetPulseOrigin (double[3])
virtual doubleGetPulseOrigin ()
virtual void GetPulseOrigin (double &, double &, double &)
virtual void GetPulseOrigin (double[3])
void SetXPulseOrigin (double f)
void SetYPulseOrigin (double f)
void SetZPulseOrigin (double f)
virtual void SetPulseWidth (double, double, double)
virtual void SetPulseWidth (double[3])
virtual doubleGetPulseWidth ()
virtual void GetPulseWidth (double &, double &, double &)
virtual void GetPulseWidth (double[3])
void SetXPulseWidth (double f)
void SetYPulseWidth (double f)
void SetZPulseWidth (double f)
virtual void SetPulseAmplitude (double)
virtual double GetPulseAmplitude ()

Static Public Member Functions

static vtkAMRGaussianPulseSourceNew ()
static int IsTypeOf (const char *type)
static vtkAMRGaussianPulseSourceSafeDownCast (vtkObjectBase *o)

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 vtkAMRGaussianPulseSource ()
virtual ~vtkAMRGaussianPulseSource ()
void GeneratePulseField (vtkUniformGrid *grid)
vtkUniformGridGetGrid (double origin[3], double h[3], int ndim[3])
vtkUniformGridRefinePatch (vtkUniformGrid *parent, int patchExtent[6])
virtual int RequestData (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
double ComputePulseAt (const double x, const double y, const double z)
double ComputePulseAt (double pt[3])
void ComputeCellCenter (vtkUniformGrid *grid, vtkIdType cellIdx, double centroid[3])
void Generate2DDataSet (vtkOverlappingAMR *amr)
void Generate3DDataSet (vtkOverlappingAMR *amr)

Protected Attributes

double RootSpacing [3]
double PulseOrigin [3]
double PulseWidth [3]
double PulseAmplitude
int RefinmentRatio
int Dimension
int NumberOfLevels

Detailed Description

A source that generates sample AMR data with gaussian pulse field. The user can control the refinement ratio as well as the pulse attributes such as the pulse origin, length and amplitude.

See also:
vtkOverlappingAMR
Tests:
vtkAMRGaussianPulseSource (Tests)

Definition at line 42 of file vtkAMRGaussianPulseSource.h.


Member Typedef Documentation

Reimplemented from vtkOverlappingAMRAlgorithm.

Definition at line 47 of file vtkAMRGaussianPulseSource.h.


Constructor & Destructor Documentation


Member Function Documentation

Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

Reimplemented from vtkOverlappingAMRAlgorithm.

static int vtkAMRGaussianPulseSource::IsTypeOf ( const char *  name) [static]

Return 1 if this class type is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkOverlappingAMRAlgorithm.

virtual int vtkAMRGaussianPulseSource::IsA ( const char *  name) [virtual]

Return 1 if this class is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkOverlappingAMRAlgorithm.

Reimplemented from vtkOverlappingAMRAlgorithm.

virtual vtkObjectBase* vtkAMRGaussianPulseSource::NewInstanceInternal ( ) const [protected, virtual]

Reimplemented from vtkOverlappingAMRAlgorithm.

Reimplemented from vtkOverlappingAMRAlgorithm.

void vtkAMRGaussianPulseSource::PrintSelf ( ostream &  os,
vtkIndent  indent 
) [virtual]

Methods invoked by print to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from vtkOverlappingAMRAlgorithm.

virtual void vtkAMRGaussianPulseSource::SetDimension ( int  ) [virtual]

Sets the dimension of the AMR dataset to generate

virtual void vtkAMRGaussianPulseSource::SetNumberOfLevels ( int  ) [virtual]

Sets the number of levels to generate

Set the refinement ratio

Definition at line 62 of file vtkAMRGaussianPulseSource.h.

Set the root spacing

Definition at line 68 of file vtkAMRGaussianPulseSource.h.

virtual void vtkAMRGaussianPulseSource::SetPulseOrigin ( double  ,
double  ,
double   
) [virtual]

Set & Get macro for the pulse origin

virtual void vtkAMRGaussianPulseSource::SetPulseOrigin ( double  [3]) [virtual]

Set & Get macro for the pulse origin

Set & Get macro for the pulse origin

virtual void vtkAMRGaussianPulseSource::GetPulseOrigin ( double ,
double ,
double  
) [virtual]

Set & Get macro for the pulse origin

virtual void vtkAMRGaussianPulseSource::GetPulseOrigin ( double  [3]) [virtual]

Set & Get macro for the pulse origin

Set & Get macro for the pulse origin

Definition at line 79 of file vtkAMRGaussianPulseSource.h.

Set & Get macro for the pulse origin

Definition at line 81 of file vtkAMRGaussianPulseSource.h.

Set & Get macro for the pulse origin

Definition at line 83 of file vtkAMRGaussianPulseSource.h.

virtual void vtkAMRGaussianPulseSource::SetPulseWidth ( double  ,
double  ,
double   
) [virtual]

Set & Get macro for the pulse width

virtual void vtkAMRGaussianPulseSource::SetPulseWidth ( double  [3]) [virtual]

Set & Get macro for the pulse width

Set & Get macro for the pulse width

virtual void vtkAMRGaussianPulseSource::GetPulseWidth ( double ,
double ,
double  
) [virtual]

Set & Get macro for the pulse width

virtual void vtkAMRGaussianPulseSource::GetPulseWidth ( double  [3]) [virtual]

Set & Get macro for the pulse width

Set & Get macro for the pulse width

Definition at line 91 of file vtkAMRGaussianPulseSource.h.

Set & Get macro for the pulse width

Definition at line 93 of file vtkAMRGaussianPulseSource.h.

Set & Get macro for the pulse width

Definition at line 95 of file vtkAMRGaussianPulseSource.h.

Set & Get macro for the pulse amplitude

Set & Get macro for the pulse amplitude

virtual int vtkAMRGaussianPulseSource::RequestData ( vtkInformation request,
vtkInformationVector **  inputVector,
vtkInformationVector outputVector 
) [protected, virtual]

This is called by the superclass. This is the method you should override.

Reimplemented from vtkUniformGridAMRAlgorithm.

double vtkAMRGaussianPulseSource::ComputePulseAt ( const double  x,
const double  y,
const double  z 
) [inline, protected]

Computes the gaussian pulse at the given location based on the user supplied parameters for pulse width and origin.

Definition at line 120 of file vtkAMRGaussianPulseSource.h.

Computes the gaussian pulse at the given location based on the user supplied parameters for pulse width and origin.

Definition at line 125 of file vtkAMRGaussianPulseSource.h.

void vtkAMRGaussianPulseSource::ComputeCellCenter ( vtkUniformGrid grid,
vtkIdType  cellIdx,
double  centroid[3] 
) [protected]

Given the cell index w.r.t. to a uniform grid, this method computes the cartesian coordinates of the centroid of the cell.

Generates a pulse field for the given uniform grid

vtkUniformGrid* vtkAMRGaussianPulseSource::GetGrid ( double  origin[3],
double  h[3],
int  ndim[3] 
) [protected]

Constructs a uniform grid path with the given origin/spacing and node dimensions. The return grid serves as the root grid for the domain.

vtkUniformGrid* vtkAMRGaussianPulseSource::RefinePatch ( vtkUniformGrid parent,
int  patchExtent[6] 
) [protected]

Constructs a refined patch from the given parent grid.

Generate 2-D or 3-D DataSet

Generate 2-D or 3-D DataSet


Member Data Documentation

Definition at line 165 of file vtkAMRGaussianPulseSource.h.

Definition at line 166 of file vtkAMRGaussianPulseSource.h.

Definition at line 167 of file vtkAMRGaussianPulseSource.h.

Definition at line 168 of file vtkAMRGaussianPulseSource.h.

Definition at line 169 of file vtkAMRGaussianPulseSource.h.

Definition at line 170 of file vtkAMRGaussianPulseSource.h.

Definition at line 171 of file vtkAMRGaussianPulseSource.h.


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