VTK  9.3.20240328
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkAMRGaussianPulseSource Class Reference

A source that generates sample AMR data with gaussian pulse field. More...

#include <vtkAMRGaussianPulseSource.h>

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

Public Types

typedef vtkOverlappingAMRAlgorithm Superclass
 
- Public Types inherited from vtkOverlappingAMRAlgorithm
typedef vtkUniformGridAMRAlgorithm Superclass
 
- Public Types inherited from vtkUniformGridAMRAlgorithm
typedef vtkAlgorithm Superclass
 
- Public Types inherited from vtkAlgorithm
enum  DesiredOutputPrecision { SINGLE_PRECISION , DOUBLE_PRECISION , DEFAULT_PRECISION }
 Values used for setting the desired output precision for various algorithms. More...
 
typedef vtkObject Superclass
 

Public Member Functions

virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class. More...
 
vtkAMRGaussianPulseSourceNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
void SetRefinementRatio (int r)
 Set the refinement ratio. More...
 
virtual void SetDimension (int)
 Sets the dimension of the AMR dataset to generate. More...
 
virtual void SetNumberOfLevels (int)
 Sets the number of levels to generate. More...
 
void SetRootSpacing (double h0)
 Set the root spacing. More...
 
virtual void SetPulseOrigin (double, double, double)
 Set & Get macro for the pulse origin. More...
 
virtual void SetPulseOrigin (double[3])
 Set & Get macro for the pulse origin. More...
 
virtual double * GetPulseOrigin ()
 Set & Get macro for the pulse origin. More...
 
virtual void GetPulseOrigin (double &, double &, double &)
 Set & Get macro for the pulse origin. More...
 
virtual void GetPulseOrigin (double[3])
 Set & Get macro for the pulse origin. More...
 
void SetXPulseOrigin (double f)
 Set & Get macro for the pulse origin. More...
 
void SetYPulseOrigin (double f)
 Set & Get macro for the pulse origin. More...
 
void SetZPulseOrigin (double f)
 Set & Get macro for the pulse origin. More...
 
virtual void SetPulseWidth (double, double, double)
 Set & Get macro for the pulse width. More...
 
virtual void SetPulseWidth (double[3])
 Set & Get macro for the pulse width. More...
 
virtual double * GetPulseWidth ()
 Set & Get macro for the pulse width. More...
 
virtual void GetPulseWidth (double &, double &, double &)
 Set & Get macro for the pulse width. More...
 
virtual void GetPulseWidth (double[3])
 Set & Get macro for the pulse width. More...
 
void SetXPulseWidth (double f)
 Set & Get macro for the pulse width. More...
 
void SetYPulseWidth (double f)
 Set & Get macro for the pulse width. More...
 
void SetZPulseWidth (double f)
 Set & Get macro for the pulse width. More...
 
virtual void SetPulseAmplitude (double)
 Set & Get macro for the pulse amplitude. More...
 
virtual double GetPulseAmplitude ()
 Set & Get macro for the pulse amplitude. More...
 
- Public Member Functions inherited from vtkOverlappingAMRAlgorithm
vtkOverlappingAMRAlgorithmNewInstance () const
 
vtkOverlappingAMRGetOutput ()
 Get the output data object for a port on this algorithm. More...
 
vtkOverlappingAMRGetOutput (int)
 Get the output data object for a port on this algorithm. More...
 
- Public Member Functions inherited from vtkUniformGridAMRAlgorithm
vtkUniformGridAMRAlgorithmNewInstance () const
 
vtkTypeBool ProcessRequest (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector) override
 See vtkAlgorithm for details. More...
 
vtkUniformGridAMRGetOutput ()
 Get the output data object for a port on this algorithm. More...
 
vtkUniformGridAMRGetOutput (int)
 Get the output data object for a port on this algorithm. More...
 
void SetInputData (vtkDataObject *)
 Set an input of this algorithm. More...
 
void SetInputData (int, vtkDataObject *)
 Set an input of this algorithm. More...
 
- Public Member Functions inherited from vtkAlgorithm
vtkAlgorithmNewInstance () const
 
vtkTypeBool HasExecutive ()
 Check whether this algorithm has an assigned executive. More...
 
vtkExecutiveGetExecutive ()
 Get this algorithm's executive. More...
 
virtual void SetExecutive (vtkExecutive *executive)
 Set this algorithm's executive. More...
 
vtkTypeBool ProcessRequest (vtkInformation *request, vtkCollection *inInfo, vtkInformationVector *outInfo)
 Version of ProcessRequest() that is wrapped. More...
 
virtual int ComputePipelineMTime (vtkInformation *request, vtkInformationVector **inInfoVec, vtkInformationVector *outInfoVec, int requestFromOutputPort, vtkMTimeType *mtime)
 A special version of ProcessRequest meant specifically for the pipeline modified time request. More...
 
virtual int ModifyRequest (vtkInformation *request, int when)
 This method gives the algorithm a chance to modify the contents of a request before or after (specified in the when argument) it is forwarded. More...
 
vtkInformationGetInputPortInformation (int port)
 Get the information object associated with an input port. More...
 
vtkInformationGetOutputPortInformation (int port)
 Get the information object associated with an output port. More...
 
int GetNumberOfInputPorts ()
 Get the number of input ports used by the algorithm. More...
 
int GetNumberOfOutputPorts ()
 Get the number of output ports provided by the algorithm. More...
 
void SetAbortExecuteAndUpdateTime ()
 Set AbortExecute Flag and update LastAbortTime. More...
 
void UpdateProgress (double amount)
 Update the progress of the process object. More...
 
bool CheckAbort ()
 Checks to see if this filter should abort. More...
 
virtual void SetInputArrayToProcess (int idx, int port, int connection, const char *fieldAssociation, const char *attributeTypeorName)
 String based versions of SetInputArrayToProcess(). More...
 
vtkInformationGetInputArrayInformation (int idx)
 Get the info object for the specified input array to this algorithm. More...
 
void RemoveAllInputs ()
 Remove all the input data. More...
 
vtkDataObjectGetOutputDataObject (int port)
 Get the data object that will contain the algorithm output for the given port. More...
 
vtkDataObjectGetInputDataObject (int port, int connection)
 Get the data object that will contain the algorithm input for the given port and given connection. More...
 
virtual void RemoveInputConnection (int port, vtkAlgorithmOutput *input)
 Remove a connection from the given input port index. More...
 
virtual void RemoveInputConnection (int port, int idx)
 Remove a connection given by index idx. More...
 
virtual void RemoveAllInputConnections (int port)
 Removes all input connections. More...
 
virtual void SetInputDataObject (int port, vtkDataObject *data)
 Sets the data-object as an input on the given port index. More...
 
virtual void SetInputDataObject (vtkDataObject *data)
 
virtual void AddInputDataObject (int port, vtkDataObject *data)
 Add the data-object as an input to this given port. More...
 
virtual void AddInputDataObject (vtkDataObject *data)
 
vtkAlgorithmOutputGetOutputPort (int index)
 Get a proxy object corresponding to the given output port of this algorithm. More...
 
vtkAlgorithmOutputGetOutputPort ()
 
int GetNumberOfInputConnections (int port)
 Get the number of inputs currently connected to a port. More...
 
int GetTotalNumberOfInputConnections ()
 Get the total number of inputs for this algorithm. More...
 
vtkAlgorithmOutputGetInputConnection (int port, int index)
 Get the algorithm output port connected to an input port. More...
 
vtkAlgorithmGetInputAlgorithm (int port, int index, int &algPort)
 Returns the algorithm and the output port index of that algorithm connected to a port-index pair. More...
 
vtkAlgorithmGetInputAlgorithm (int port, int index)
 Returns the algorithm connected to a port-index pair. More...
 
vtkAlgorithmGetInputAlgorithm ()
 Equivalent to GetInputAlgorithm(0, 0). More...
 
vtkExecutiveGetInputExecutive (int port, int index)
 Returns the executive associated with a particular input connection. More...
 
vtkExecutiveGetInputExecutive ()
 Equivalent to GetInputExecutive(0, 0) More...
 
vtkInformationGetInputInformation (int port, int index)
 Return the information object that is associated with a particular input connection. More...
 
vtkInformationGetInputInformation ()
 Equivalent to GetInputInformation(0, 0) More...
 
vtkInformationGetOutputInformation (int port)
 Return the information object that is associated with a particular output port. More...
 
virtual vtkTypeBool Update (int port, vtkInformationVector *requests)
 This method enables the passing of data requests to the algorithm to be used during execution (in addition to bringing a particular port up-to-date). More...
 
virtual vtkTypeBool Update (vtkInformation *requests)
 Convenience method to update an algorithm after passing requests to its first output port. More...
 
virtual int UpdatePiece (int piece, int numPieces, int ghostLevels, const int extents[6]=nullptr)
 Convenience method to update an algorithm after passing requests to its first output port. More...
 
virtual int UpdateExtent (const int extents[6])
 Convenience method to update an algorithm after passing requests to its first output port. More...
 
virtual int UpdateTimeStep (double time, int piece=-1, int numPieces=1, int ghostLevels=0, const int extents[6]=nullptr)
 Convenience method to update an algorithm after passing requests to its first output port. More...
 
virtual void UpdateInformation ()
 Bring the algorithm's information up-to-date. More...
 
virtual void UpdateDataObject ()
 Create output object(s). More...
 
virtual void PropagateUpdateExtent ()
 Propagate meta-data upstream. More...
 
virtual void UpdateWholeExtent ()
 Bring this algorithm's outputs up-to-date. More...
 
void ConvertTotalInputToPortConnection (int ind, int &port, int &conn)
 Convenience routine to convert from a linear ordering of input connections to a port/connection pair. More...
 
void RemoveNoPriorTemporalAccessInformationKey ()
 Removes any information key vtkStreamingDemandDrivenPipeline::NO_PRIOR_TEMPORAL_ACCESS() to all output ports of this vtkAlgorithm. More...
 
virtual vtkInformationGetInformation ()
 Set/Get the information object associated with this algorithm. More...
 
virtual void SetInformation (vtkInformation *)
 Set/Get the information object associated with this algorithm. More...
 
bool UsesGarbageCollector () const override
 Participate in garbage collection. More...
 
virtual void SetAbortExecute (vtkTypeBool)
 Set/Get the AbortExecute flag for the process object. More...
 
virtual vtkTypeBool GetAbortExecute ()
 Set/Get the AbortExecute flag for the process object. More...
 
virtual void AbortExecuteOn ()
 Set/Get the AbortExecute flag for the process object. More...
 
virtual void AbortExecuteOff ()
 Set/Get the AbortExecute flag for the process object. More...
 
virtual double GetProgress ()
 Get the execution progress of a process object. More...
 
void SetContainerAlgorithm (vtkAlgorithm *containerAlg)
 Set/get a Container algorithm for this algorithm. More...
 
vtkAlgorithmGetContainerAlgorithm ()
 Set/get a Container algorithm for this algorithm. More...
 
virtual void SetAbortOutput (bool)
 Set/Get an internal variable used to communicate between the algorithm and executive. More...
 
virtual bool GetAbortOutput ()
 Set/Get an internal variable used to communicate between the algorithm and executive. More...
 
void SetProgressShiftScale (double shift, double scale)
 Specify the shift and scale values to use to apply to the progress amount when UpdateProgress is called. More...
 
virtual double GetProgressShift ()
 Specify the shift and scale values to use to apply to the progress amount when UpdateProgress is called. More...
 
virtual double GetProgressScale ()
 Specify the shift and scale values to use to apply to the progress amount when UpdateProgress is called. More...
 
void SetProgressText (const char *ptext)
 Set the current text message associated with the progress state. More...
 
virtual char * GetProgressText ()
 Set the current text message associated with the progress state. More...
 
virtual unsigned long GetErrorCode ()
 The error code contains a possible error that occurred while reading or writing the file. More...
 
virtual void SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, const char *name)
 Set the input data arrays that this algorithm will process. More...
 
virtual void SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, int fieldAttributeType)
 Set the input data arrays that this algorithm will process. More...
 
virtual void SetInputArrayToProcess (int idx, vtkInformation *info)
 Set the input data arrays that this algorithm will process. More...
 
virtual void SetInputConnection (int port, vtkAlgorithmOutput *input)
 Set the connection for the given input port index. More...
 
virtual void SetInputConnection (vtkAlgorithmOutput *input)
 Set the connection for the given input port index. More...
 
virtual void AddInputConnection (int port, vtkAlgorithmOutput *input)
 Add a connection to the given input port index. More...
 
virtual void AddInputConnection (vtkAlgorithmOutput *input)
 Add a connection to the given input port index. More...
 
virtual void Update (int port)
 Bring this algorithm's outputs up-to-date. More...
 
virtual void Update ()
 Bring this algorithm's outputs up-to-date. More...
 
virtual void SetReleaseDataFlag (vtkTypeBool)
 Turn release data flag on or off for all output ports. More...
 
virtual vtkTypeBool GetReleaseDataFlag ()
 Turn release data flag on or off for all output ports. More...
 
void ReleaseDataFlagOn ()
 Turn release data flag on or off for all output ports. More...
 
void ReleaseDataFlagOff ()
 Turn release data flag on or off for all output ports. More...
 
int UpdateExtentIsEmpty (vtkInformation *pinfo, vtkDataObject *output)
 This detects when the UpdateExtent will generate no data This condition is satisfied when the UpdateExtent has zero volume (0,-1,...) or the UpdateNumberOfPieces is 0. More...
 
int UpdateExtentIsEmpty (vtkInformation *pinfo, int extentType)
 This detects when the UpdateExtent will generate no data This condition is satisfied when the UpdateExtent has zero volume (0,-1,...) or the UpdateNumberOfPieces is 0. More...
 
int * GetUpdateExtent ()
 These functions return the update extent for output ports that use 3D extents. More...
 
int * GetUpdateExtent (int port)
 These functions return the update extent for output ports that use 3D extents. More...
 
void GetUpdateExtent (int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
 These functions return the update extent for output ports that use 3D extents. More...
 
void GetUpdateExtent (int port, int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
 These functions return the update extent for output ports that use 3D extents. More...
 
void GetUpdateExtent (int extent[6])
 These functions return the update extent for output ports that use 3D extents. More...
 
void GetUpdateExtent (int port, int extent[6])
 These functions return the update extent for output ports that use 3D extents. More...
 
int GetUpdatePiece ()
 These functions return the update extent for output ports that use piece extents. More...
 
int GetUpdatePiece (int port)
 These functions return the update extent for output ports that use piece extents. More...
 
int GetUpdateNumberOfPieces ()
 These functions return the update extent for output ports that use piece extents. More...
 
int GetUpdateNumberOfPieces (int port)
 These functions return the update extent for output ports that use piece extents. More...
 
int GetUpdateGhostLevel ()
 These functions return the update extent for output ports that use piece extents. More...
 
int GetUpdateGhostLevel (int port)
 These functions return the update extent for output ports that use piece extents. More...
 
void SetProgressObserver (vtkProgressObserver *)
 If an ProgressObserver is set, the algorithm will report progress through it rather than directly. More...
 
virtual vtkProgressObserverGetProgressObserver ()
 If an ProgressObserver is set, the algorithm will report progress through it rather than directly. More...
 
void SetNoPriorTemporalAccessInformationKey (int key)
 Set to all output ports of this algorithm the information key vtkStreamingDemandDrivenPipeline::NO_PRIOR_TEMPORAL_ACCESS(). More...
 
void SetNoPriorTemporalAccessInformationKey ()
 Set to all output ports of this algorithm the information key vtkStreamingDemandDrivenPipeline::NO_PRIOR_TEMPORAL_ACCESS(). More...
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 Turn debugging output on. More...
 
virtual void DebugOff ()
 Turn debugging output off. More...
 
bool GetDebug ()
 Get the value of the debug flag. More...
 
void SetDebug (bool debugFlag)
 Set the value of the debug flag. More...
 
virtual void Modified ()
 Update the modification time for this object. More...
 
virtual vtkMTimeType GetMTime ()
 Return this object's modified time. More...
 
void RemoveObserver (unsigned long tag)
 
void RemoveObservers (unsigned long event)
 
void RemoveObservers (const char *event)
 
void RemoveAllObservers ()
 
vtkTypeBool HasObserver (unsigned long event)
 
vtkTypeBool HasObserver (const char *event)
 
vtkTypeBool InvokeEvent (unsigned long event)
 
vtkTypeBool InvokeEvent (const char *event)
 
std::string GetObjectDescription () const override
 The object description printed in messages and PrintSelf output. More...
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkCommandGetCommand (unsigned long tag)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObserver (vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObservers (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObservers (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 Allow user to set the AbortFlagOn() with the return value of the callback method. More...
 
vtkTypeBool InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
vtkTypeBool InvokeEvent (const char *event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
virtual void SetObjectName (const std::string &objectName)
 Set/get the name of this object for reporting purposes. More...
 
virtual std::string GetObjectName () const
 Set/get the name of this object for reporting purposes. More...
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string. More...
 
virtual vtkIdType GetNumberOfGenerationsFromBase (const char *name)
 Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class). More...
 
virtual void Delete ()
 Delete a VTK object. More...
 
virtual void FastDelete ()
 Delete a reference to this object. More...
 
void InitializeObjectBase ()
 
void Print (ostream &os)
 Print an object to an ostream. More...
 
void Register (vtkObjectBase *o)
 Increase the reference count (mark as used by another object). More...
 
virtual void UnRegister (vtkObjectBase *o)
 Decrease the reference count (release by another object). More...
 
int GetReferenceCount ()
 Return the current reference count of this object. More...
 
void SetReferenceCount (int)
 Sets the reference count. More...
 
bool GetIsInMemkind () const
 A local state flag that remembers whether this object lives in the normal or extended memory space. More...
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 

Static Public Member Functions

static vtkAMRGaussianPulseSourceNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkAMRGaussianPulseSourceSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkOverlappingAMRAlgorithm
static vtkOverlappingAMRAlgorithmNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkOverlappingAMRAlgorithmSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkUniformGridAMRAlgorithm
static vtkUniformGridAMRAlgorithmNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkUniformGridAMRAlgorithmSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkAlgorithm
static vtkAlgorithmNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkAlgorithmSafeDownCast (vtkObjectBase *o)
 
static vtkInformationIntegerKeyINPUT_IS_OPTIONAL ()
 Keys used to specify input port requirements. More...
 
static vtkInformationIntegerKeyINPUT_IS_REPEATABLE ()
 
static vtkInformationInformationVectorKeyINPUT_REQUIRED_FIELDS ()
 
static vtkInformationStringVectorKeyINPUT_REQUIRED_DATA_TYPE ()
 
static vtkInformationInformationVectorKeyINPUT_ARRAYS_TO_PROCESS ()
 
static vtkInformationIntegerKeyINPUT_PORT ()
 
static vtkInformationIntegerKeyINPUT_CONNECTION ()
 
static vtkInformationIntegerKeyCAN_PRODUCE_SUB_EXTENT ()
 This key tells the executive that a particular output port is capable of producing an arbitrary subextent of the whole extent. More...
 
static vtkInformationIntegerKeyCAN_HANDLE_PIECE_REQUEST ()
 Key that tells the pipeline that a particular algorithm can or cannot handle piece request. More...
 
static vtkInformationIntegerKeyABORTED ()
 
static void SetDefaultExecutivePrototype (vtkExecutive *proto)
 If the DefaultExecutivePrototype is set, a copy of it is created in CreateDefaultExecutive() using NewInstance(). More...
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
static void BreakOnError ()
 This method is called when vtkErrorMacro executes. More...
 
static void SetGlobalWarningDisplay (vtkTypeBool val)
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOn ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOff ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static vtkTypeBool GetGlobalWarningDisplay ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
- Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool IsTypeOf (const char *name)
 Return 1 if this class type is the same type of (or a subclass of) the named class. More...
 
static vtkIdType GetNumberOfGenerationsFromBaseType (const char *name)
 Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class). More...
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
static void SetMemkindDirectory (const char *directoryname)
 The name of a directory, ideally mounted -o dax, to memory map an extended memory space within. More...
 
static bool GetUsingMemkind ()
 A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkAMRGaussianPulseSource ()
 
 ~vtkAMRGaussianPulseSource () override
 
int RequestData (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector) override
 This is called by the superclass. More...
 
void ComputeCellCenter (vtkUniformGrid *grid, vtkIdType cellIdx, double centroid[3])
 Given the cell index w.r.t. More...
 
void GeneratePulseField (vtkUniformGrid *grid)
 Generates a pulse field for the given uniform grid. More...
 
vtkUniformGridGetGrid (double origin[3], double h[3], int ndim[3])
 Constructs a uniform grid path with the given origin/spacing and node dimensions. More...
 
vtkUniformGridRefinePatch (vtkUniformGrid *parent, int patchExtent[6])
 Constructs a refined patch from the given parent grid. More...
 
double ComputePulseAt (const double x, const double y, const double z)
 Computes the gaussian pulse at the given location based on the user supplied parameters for pulse width and origin. More...
 
double ComputePulseAt (double pt[3])
 Computes the gaussian pulse at the given location based on the user supplied parameters for pulse width and origin. More...
 
void Generate2DDataSet (vtkOverlappingAMR *amr)
 Generate 2-D or 3-D DataSet. More...
 
void Generate3DDataSet (vtkOverlappingAMR *amr)
 Generate 2-D or 3-D DataSet. More...
 
- Protected Member Functions inherited from vtkOverlappingAMRAlgorithm
 vtkOverlappingAMRAlgorithm ()
 
 ~vtkOverlappingAMRAlgorithm () override
 
int FillOutputPortInformation (int port, vtkInformation *info) override
 See algorithm for more info. More...
 
int FillInputPortInformation (int port, vtkInformation *info) override
 See algorithm for more info. More...
 
- Protected Member Functions inherited from vtkUniformGridAMRAlgorithm
 vtkUniformGridAMRAlgorithm ()
 
 ~vtkUniformGridAMRAlgorithm () override
 
virtual int RequestDataObject (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 This is called by the superclass. More...
 
virtual int RequestInformation (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 This is called by the superclass. More...
 
virtual int RequestUpdateExtent (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 This is called by the superclass. More...
 
virtual int RequestUpdateTime (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 
vtkExecutiveCreateDefaultExecutive () override
 Create a default executive. More...
 
vtkDataObjectGetInput (int port)
 
int FillOutputPortInformation (int port, vtkInformation *info) override
 See algorithm for more info. More...
 
int FillInputPortInformation (int port, vtkInformation *info) override
 See algorithm for more info. More...
 
- Protected Member Functions inherited from vtkAlgorithm
 vtkAlgorithm ()
 
 ~vtkAlgorithm () override
 
bool CheckUpstreamAbort ()
 Checks to see if an upstream filter has been aborted. More...
 
virtual void SetNumberOfInputPorts (int n)
 Set the number of input ports used by the algorithm. More...
 
virtual void SetNumberOfOutputPorts (int n)
 Set the number of output ports provided by the algorithm. More...
 
int InputPortIndexInRange (int index, const char *action)
 
int OutputPortIndexInRange (int index, const char *action)
 
int GetInputArrayAssociation (int idx, vtkInformationVector **inputVector)
 Get the association of the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass. More...
 
vtkInformationGetInputArrayFieldInformation (int idx, vtkInformationVector **inputVector)
 This method takes in an index (as specified in SetInputArrayToProcess) and a pipeline information vector. More...
 
void ReportReferences (vtkGarbageCollector *) override
 
virtual void SetNthInputConnection (int port, int index, vtkAlgorithmOutput *input)
 Replace the Nth connection on the given input port. More...
 
virtual void SetNumberOfInputConnections (int port, int n)
 Set the number of input connections on the given input port. More...
 
void SetInputDataInternal (int port, vtkDataObject *input)
 These methods are used by subclasses to implement methods to set data objects directly as input. More...
 
void AddInputDataInternal (int port, vtkDataObject *input)
 
int GetInputArrayAssociation (int idx, int connection, vtkInformationVector **inputVector)
 Filters that have multiple connections on one port can use this signature. More...
 
int GetInputArrayAssociation (int idx, vtkDataObject *input)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkInformationVector **inputVector)
 Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass. More...
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
 Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass. More...
 
vtkDataArrayGetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkDataArrayGetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input, int &association)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector)
 Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass. More...
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
 Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass. More...
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkDataObject *input)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkDataObject *input, int &association)
 Filters that have multiple connections on one port can use this signature. More...
 
virtual void SetErrorCode (unsigned long)
 The error code contains a possible error that occurred while reading or writing the file. More...
 
- Protected Member Functions inherited from vtkObject
 vtkObject ()
 
 ~vtkObject () override
 
void RegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=nullptr)
 These methods allow a command to exclusively grab all events. More...
 
void InternalReleaseFocus ()
 These methods allow a command to exclusively grab all events. More...
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

double RootSpacing [3]
 
double PulseOrigin [3]
 
double PulseWidth [3]
 
double PulseAmplitude
 
int RefinmentRatio
 
int Dimension
 
int NumberOfLevels
 
- Protected Attributes inherited from vtkAlgorithm
vtkTimeStamp LastAbortCheckTime
 
vtkInformationInformation
 
double Progress
 
char * ProgressText
 
vtkProgressObserverProgressObserver
 
unsigned long ErrorCode
 The error code contains a possible error that occurred while reading or writing the file. More...
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
std::string ObjectName
 
- Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t > ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Additional Inherited Members

- Public Attributes inherited from vtkAlgorithm
std::atomic< vtkTypeBoolAbortExecute
 
- Static Protected Member Functions inherited from vtkAlgorithm
static vtkInformationIntegerKeyPORT_REQUIREMENTS_FILLED ()
 
- Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction GetCurrentMallocFunction ()
 
static vtkReallocingFunction GetCurrentReallocFunction ()
 
static vtkFreeingFunction GetCurrentFreeFunction ()
 
static vtkFreeingFunction GetAlternateFreeFunction ()
 
- Static Protected Attributes inherited from vtkAlgorithm
static vtkTimeStamp LastAbortTime
 
static vtkExecutiveDefaultExecutivePrototype
 

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 32 of file vtkAMRGaussianPulseSource.h.

Member Typedef Documentation

◆ Superclass

Definition at line 36 of file vtkAMRGaussianPulseSource.h.

Constructor & Destructor Documentation

◆ vtkAMRGaussianPulseSource()

vtkAMRGaussianPulseSource::vtkAMRGaussianPulseSource ( )
protected

◆ ~vtkAMRGaussianPulseSource()

vtkAMRGaussianPulseSource::~vtkAMRGaussianPulseSource ( )
overrideprotected

Member Function Documentation

◆ New()

static vtkAMRGaussianPulseSource* vtkAMRGaussianPulseSource::New ( )
static

◆ IsTypeOf()

static vtkTypeBool vtkAMRGaussianPulseSource::IsTypeOf ( const char *  type)
static

◆ IsA()

virtual vtkTypeBool 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.

◆ SafeDownCast()

static vtkAMRGaussianPulseSource* vtkAMRGaussianPulseSource::SafeDownCast ( vtkObjectBase o)
static

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkAMRGaussianPulseSource::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkOverlappingAMRAlgorithm.

◆ NewInstance()

vtkAMRGaussianPulseSource* vtkAMRGaussianPulseSource::NewInstance ( ) const

◆ PrintSelf()

void vtkAMRGaussianPulseSource::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
overridevirtual

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.

◆ SetDimension()

virtual void vtkAMRGaussianPulseSource::SetDimension ( int  )
virtual

Sets the dimension of the AMR dataset to generate.

◆ SetNumberOfLevels()

virtual void vtkAMRGaussianPulseSource::SetNumberOfLevels ( int  )
virtual

Sets the number of levels to generate.

◆ SetRefinementRatio()

void vtkAMRGaussianPulseSource::SetRefinementRatio ( int  r)
inline

Set the refinement ratio.

Definition at line 56 of file vtkAMRGaussianPulseSource.h.

◆ SetRootSpacing()

void vtkAMRGaussianPulseSource::SetRootSpacing ( double  h0)
inline

Set the root spacing.

Definition at line 66 of file vtkAMRGaussianPulseSource.h.

◆ SetPulseOrigin() [1/2]

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

Set & Get macro for the pulse origin.

◆ SetPulseOrigin() [2/2]

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

Set & Get macro for the pulse origin.

◆ GetPulseOrigin() [1/3]

virtual double* vtkAMRGaussianPulseSource::GetPulseOrigin ( )
virtual

Set & Get macro for the pulse origin.

◆ GetPulseOrigin() [2/3]

virtual void vtkAMRGaussianPulseSource::GetPulseOrigin ( double &  ,
double &  ,
double &   
)
virtual

Set & Get macro for the pulse origin.

◆ GetPulseOrigin() [3/3]

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

Set & Get macro for the pulse origin.

◆ SetXPulseOrigin()

void vtkAMRGaussianPulseSource::SetXPulseOrigin ( double  f)
inline

Set & Get macro for the pulse origin.

Definition at line 79 of file vtkAMRGaussianPulseSource.h.

◆ SetYPulseOrigin()

void vtkAMRGaussianPulseSource::SetYPulseOrigin ( double  f)
inline

Set & Get macro for the pulse origin.

Definition at line 84 of file vtkAMRGaussianPulseSource.h.

◆ SetZPulseOrigin()

void vtkAMRGaussianPulseSource::SetZPulseOrigin ( double  f)
inline

Set & Get macro for the pulse origin.

Definition at line 89 of file vtkAMRGaussianPulseSource.h.

◆ SetPulseWidth() [1/2]

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

Set & Get macro for the pulse width.

◆ SetPulseWidth() [2/2]

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

Set & Get macro for the pulse width.

◆ GetPulseWidth() [1/3]

virtual double* vtkAMRGaussianPulseSource::GetPulseWidth ( )
virtual

Set & Get macro for the pulse width.

◆ GetPulseWidth() [2/3]

virtual void vtkAMRGaussianPulseSource::GetPulseWidth ( double &  ,
double &  ,
double &   
)
virtual

Set & Get macro for the pulse width.

◆ GetPulseWidth() [3/3]

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

Set & Get macro for the pulse width.

◆ SetXPulseWidth()

void vtkAMRGaussianPulseSource::SetXPulseWidth ( double  f)
inline

Set & Get macro for the pulse width.

Definition at line 102 of file vtkAMRGaussianPulseSource.h.

◆ SetYPulseWidth()

void vtkAMRGaussianPulseSource::SetYPulseWidth ( double  f)
inline

Set & Get macro for the pulse width.

Definition at line 107 of file vtkAMRGaussianPulseSource.h.

◆ SetZPulseWidth()

void vtkAMRGaussianPulseSource::SetZPulseWidth ( double  f)
inline

Set & Get macro for the pulse width.

Definition at line 112 of file vtkAMRGaussianPulseSource.h.

◆ SetPulseAmplitude()

virtual void vtkAMRGaussianPulseSource::SetPulseAmplitude ( double  )
virtual

Set & Get macro for the pulse amplitude.

◆ GetPulseAmplitude()

virtual double vtkAMRGaussianPulseSource::GetPulseAmplitude ( )
virtual

Set & Get macro for the pulse amplitude.

◆ RequestData()

int vtkAMRGaussianPulseSource::RequestData ( vtkInformation request,
vtkInformationVector **  inputVector,
vtkInformationVector outputVector 
)
overrideprotectedvirtual

This is called by the superclass.

This is the method you should override.

Reimplemented from vtkUniformGridAMRAlgorithm.

◆ ComputePulseAt() [1/2]

double vtkAMRGaussianPulseSource::ComputePulseAt ( const double  x,
const double  y,
const double  z 
)
inlineprotected

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

Definition at line 143 of file vtkAMRGaussianPulseSource.h.

◆ ComputePulseAt() [2/2]

double vtkAMRGaussianPulseSource::ComputePulseAt ( double  pt[3])
inlineprotected

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

Definition at line 151 of file vtkAMRGaussianPulseSource.h.

◆ ComputeCellCenter()

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.

◆ GeneratePulseField()

void vtkAMRGaussianPulseSource::GeneratePulseField ( vtkUniformGrid grid)
protected

Generates a pulse field for the given uniform grid.

◆ GetGrid()

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.

◆ RefinePatch()

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

Constructs a refined patch from the given parent grid.

◆ Generate2DDataSet()

void vtkAMRGaussianPulseSource::Generate2DDataSet ( vtkOverlappingAMR amr)
protected

Generate 2-D or 3-D DataSet.

◆ Generate3DDataSet()

void vtkAMRGaussianPulseSource::Generate3DDataSet ( vtkOverlappingAMR amr)
protected

Generate 2-D or 3-D DataSet.

Member Data Documentation

◆ RootSpacing

double vtkAMRGaussianPulseSource::RootSpacing[3]
protected

Definition at line 197 of file vtkAMRGaussianPulseSource.h.

◆ PulseOrigin

double vtkAMRGaussianPulseSource::PulseOrigin[3]
protected

Definition at line 198 of file vtkAMRGaussianPulseSource.h.

◆ PulseWidth

double vtkAMRGaussianPulseSource::PulseWidth[3]
protected

Definition at line 199 of file vtkAMRGaussianPulseSource.h.

◆ PulseAmplitude

double vtkAMRGaussianPulseSource::PulseAmplitude
protected

Definition at line 200 of file vtkAMRGaussianPulseSource.h.

◆ RefinmentRatio

int vtkAMRGaussianPulseSource::RefinmentRatio
protected

Definition at line 201 of file vtkAMRGaussianPulseSource.h.

◆ Dimension

int vtkAMRGaussianPulseSource::Dimension
protected

Definition at line 202 of file vtkAMRGaussianPulseSource.h.

◆ NumberOfLevels

int vtkAMRGaussianPulseSource::NumberOfLevels
protected

Definition at line 203 of file vtkAMRGaussianPulseSource.h.


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