Shortcuts

Template Function ripple::storage_ptr

Function Documentation

template<typename Block, size_t Dim, FaceLocation Location, Mapping Map>
auto ripple::storage_ptr(Block &block, CopySpecifier<Dim, Location, Map>, OffsetParam offset = OffsetParam()) noexcept

Gets a pointer to the start of the padding for the block for the given copy spcification.

Note

If the iterated type is a storage accessor and therefore could be strided or contiguous, then the underlying storage type is returned, otherwise a raw pointer to the data is returned.

Parameters
  • block: The block to get the padding pointer for.

  • offset: An additional offset for the pointer.

Template Parameters
  • Block: The type of the block.

  • Dim: The dimension in which to get the padding pointer.

  • Location: The destination face for the padding.

  • Map: The mapping for the copy.

Docs

Access comprehensive developer documentation for Ripple

View Docs

Tutorials

Get tutorials to help with understand all features

View Tutorials

Examples

Find examples to help get started

View Examples