Class MessageSpatial2D
Defined in File MessageSpatial2D.h
Class Documentation
-
class MessageSpatial2D
2D Continuous spatial messaging functionality
User specifies the environment bounds and search radius When accessing messages, a search origin is specified A subset of messages, including those within radius of the search origin are returned The user must distance check that they fall within the search radius manually Unlike FLAMEGPU1, these spatial messages do not wrap over environment bounds.
-
class CUDAModelHandler : public flamegpu::MessageSpecialisationHandler
CUDA host side handler of spatial messages Allocates memory for and constructs PBM
Public Functions
-
explicit CUDAModelHandler(CUDAMessage &a)
Constructor
Initialises metadata, decides PBM size etc
- Parameters
a – Parent CUDAMessage, used to access message settings, data ptrs etc
-
~CUDAModelHandler() override
Destructor Frees all alocated memory
-
virtual void init(CUDAScatter &scatter, unsigned int streamId, cudaStream_t stream) override
Allocates memory for the constructed index. Sets data asthough message list is empty
- Parameters
scatter – Scatter instance and scan arrays to be used (CUDASimulation::singletons->scatter)
streamId – Index of stream specific structures used
stream – The CUDAStream to use for CUDA operations
-
virtual void buildIndex(CUDAScatter &scatter, unsigned int streamId, cudaStream_t stream) override
Reconstructs the partition boundary matrix This should be called before reading newly output messages
- Parameters
scatter – Scatter instance and scan arrays to be used (CUDASimulation::singletons->scatter)
streamId – The stream index to use for accessing stream specific resources such as scan compaction arrays and buffers
stream – The CUDAStream to use for CUDA operations
-
virtual void allocateMetaDataDevicePtr(cudaStream_t stream) override
Allocates memory for the constructed index. The memory allocation is checked by build index.
-
virtual void freeMetaDataDevicePtr() override
Releases memory for the constructed index.
-
inline virtual const void *getMetaDataDevicePtr() const override
Returns a pointer to the metadata struct, this is required for reading the message data
-
explicit CUDAModelHandler(CUDAMessage &a)
-
struct Data : public flamegpu::MessageBruteForce::Data
Internal data representation of Spatial2D messages within model description hierarchy
See also
Subclassed by flamegpu::MessageSpatial3D::Data
Public Functions
-
virtual ~Data() = default
-
virtual std::unique_ptr<MessageSpecialisationHandler> getSpecialisationHander(CUDAMessage &owner) const override
-
virtual std::type_index getType() const override
Used internally to validate that the corresponding Message type is attached via the agent function shim.
- Returns
The std::type_index of the Message type which must be used.
-
virtual flamegpu::MessageSortingType getSortingType() const override
Return the sorting type for this message type
Protected Functions
Copy constructor This is unsafe, should only be used internally, use clone() instead
Normal constructor, only to be called by ModelDescription
Friends
- friend class ModelDescription
- friend struct ModelData
-
virtual ~Data() = default
-
class Description : public flamegpu::MessageBruteForce::Description
User accessible interface to Spatial2D messages within mode description hierarchy
See also
Public Functions
-
void setRadius(const float &r)
-
void setMinX(const float &x)
-
void setMinY(const float &y)
-
void setMin(const float &x, const float &y)
-
void setMaxX(const float &x)
-
void setMaxY(const float &y)
-
void setMax(const float &x, const float &y)
-
float getRadius() const
-
float getMinX() const
-
float getMinY() const
-
float getMaxX() const
-
float getMaxY() const
Protected Functions
Constructors
-
Description(const Description &other_message) = delete
Default copy constructor, not implemented
-
Description(Description &&other_message) noexcept = delete
Default move constructor, not implemented
-
Description &operator=(const Description &other_message) = delete
Default copy assignment, not implemented
-
Description &operator=(Description &&other_message) noexcept = delete
Default move assignment, not implemented
-
void setRadius(const float &r)
-
struct GridPos2D
Basic class to group 3 dimensional bin coordinates Would use glm::ivec3, but project does not currently have glm
-
class In
This class is accessible via DeviceAPI.message_in if MessageSpatial3D is specified in FLAMEGPU_AGENT_FUNCTION It gives access to functionality for reading spatially partitioned messages
Public Functions
-
__device__ inline In(const void *_metadata)
Constructer Initialises member variables
- Parameters
_metadata – Reinterpreted as type MessageSpatial3D::MetaData
-
__device__ inline Filter operator()(const float &x, const float &y) const
Returns a Filter object which provides access to message iterator for iterating a subset of messages including those within the radius of the search origin
- Parameters
x – Search origin x coord
y – Search origin y coord
-
__forceinline__ __device__ inline float radius() const
Returns the search radius of the message list defined in the model description
-
class Filter
This class is created when a search origin is provided to MessageSpatial2D::In::operator()(float, float) It provides iterator access to a subset of the full message list, according to the provided search origin
See also
MessageSpatial2D::In::operator()(float, float)
Public Functions
-
__device__ inline Filter(const MetaData *_metadata, const float &x, const float &y)
Constructor, takes the search parameters requried
- Parameters
_metadata – Pointer to message list metadata
x – Search origin x coord
y – Search origin y coord
-
class iterator
Stock iterator for iterating MessageSpatial3D::In::Filter::Message objects
Public Functions
-
__device__ inline iterator(const Filter &parent, const int &relative_cell_y, const int &_cell_index_max, const int &_cell_index)
Constructor This iterator is constructed by MessageSpatial2D::In::Filter::begin()(float, float)
See also
MessageSpatial2D::In::Operator()(float, float)
-
__device__ inline iterator(const Filter &parent)
False constructor Only used by Filter::end(), creates a null objct
-
__device__ inline iterator operator++(int)
Moves to the next message (Postfix increment operator, returns value prior to increment)
-
__device__ inline iterator(const Filter &parent, const int &relative_cell_y, const int &_cell_index_max, const int &_cell_index)
-
class Message
Provides access to a specific message Returned by the iterator
See also
Public Functions
-
__device__ inline Message(const Filter &parent, const int &relative_cell_y, const int &_cell_index_max, const int &_cell_index)
Constructs a message and directly initialises all of it’s member variables
Note
See member variable documentation for their purposes
-
__device__ inline bool operator==(const Message &rhs) const
Equality operator Compares all internal member vars for equality
Note
Does not compare _parent
-
__device__ inline bool operator!=(const Message &rhs) const
This should only be called to compare against end() It has been modified to check for end of iteration with minimal instructions Therefore it does not even perform the equality operation
Note
Use operator==() if proper equality is required
-
__device__ inline Message &operator++()
Updates the message to return variables from the next message in the message list
- Returns
Returns itself
-
__device__ inline void nextStrip()
Utility function for deciding next strip to access
-
template<typename T, unsigned int N>
__device__ T getVariable(const char (&variable_name)[N]) const Returns the value for the current message attached to the named variable
- Parameters
variable_name – Name of the variable
- Template Parameters
T – type of the variable
N – Length of variable name (this should be implicit if a string literal is passed to variable name)
- Returns
The specified variable, else 0x0 if an error occurs
-
template<typename T, MessageNone::size_type N, unsigned int M>
__device__ T getVariable(const char (&variable_name)[M], const unsigned int &index) const Returns the specified variable array element from the current message attached to the named variable
- Parameters
variable_name – name used for accessing the variable, this value should be a string literal e.g. “foobar”
index – Index of the element within the variable array to return
- Template Parameters
T – Type of the message variable being accessed
N – The length of the array variable, as set within the model description hierarchy
M – Length of variable_name, this should always be implicit if passing a string literal
- Throws
exception::DeviceError – If name is not a valid variable within the agent (flamegpu must be built with SEATBELTS enabled for device error checking)
exception::DeviceError – If T is not the type of variable ‘name’ within the message (flamegpu must be built with SEATBELTS enabled for device error checking)
exception::DeviceError – If index is out of bounds for the variable array specified by name (flamegpu must be built with SEATBELTS enabled for device error checking)
-
__device__ inline Message(const Filter &parent, const int &relative_cell_y, const int &_cell_index_max, const int &_cell_index)
-
__device__ inline Filter(const MetaData *_metadata, const float &x, const float &y)
-
__device__ inline In(const void *_metadata)
-
struct MetaData
MetaData required by spatial partitioning during message reads
Public Members
-
float min[2]
Minimum environment bounds
-
float max[2]
Maximum environment bounds
-
float radius
Search radius (also used as subdividision bin width)
-
unsigned int *PBM
Pointer to the partition boundary matrix in device memory The PBM is never stored on the host
-
unsigned int gridDim[2]
The number of subdividision bins in each dimensions
-
float environmentWidth[3]
max-lowerBound
-
float min[2]
-
class Out : public flamegpu::MessageBruteForce::Out
This class is accessible via DeviceAPI.message_out if MessageSpatial3D is specified in FLAMEGPU_AGENT_FUNCTION It gives access to functionality for outputting spatially partitioned messages
Public Functions
-
__device__ inline Out(const void*, unsigned int *scan_flag_messageOutput)
Constructer Initialises member variables
- Parameters
scan_flag_messageOutput – Scan flag array for optional message output
-
__device__ inline void setLocation(const float &x, const float &y) const
Sets the location for this agents message
Note
Convenience wrapper for setVariable()
- Parameters
x – Message x coord
y – Message y coord
-
__device__ inline Out(const void*, unsigned int *scan_flag_messageOutput)
-
class CUDAModelHandler : public flamegpu::MessageSpecialisationHandler