Mdarray_module

Multi-dimensional array view of a contiguous block of member data with the array dimension ordinates documented by "tags". More...

Detailed Description

Multi-dimensional array view of a contiguous block of member data with the array dimension ordinates documented by "tags".

Author:: H. Carter Edwards <hcedwar@sandia.gov>

Date:: June 2008 Trivial Example of a Function accepting a 2D Array

Given the user-defined array dimension tags Cartesian3D and Points define a function to find the centroid of an array of points.

  void centroid( const Array<double,FortranOrder,Cartesian3D,Points> points ,
                 const Array<double,FortranOrder,Cartesian3D> x )
  {
    const unsigned nspace  = points.dimension<0>();
    const unsigned npoints = points.dimension<1>();

    for ( unsigned id = 0 ; ip < npoints ; ++id ) {
      x(id) = 0 ;
    }
    for ( unsigned ip = 0 ; ip < npoints ; ++ip ) {
      for ( unsigned id = 0 ; id < npoints ; ++id ) {
        x(id) += points( id , ip );
      }
    }
    for ( unsigned id = 0 ; ip < npoints ; ++id ) {
      x(id) /= npoints ;
    }
  }

Example of User-defined Array Dimension Tags

  struct Cartesian3D : public ArrayDimTag {
    enum { Size = 3 };                // Default size for this dimension.
    const char * name() const ;       // Supply the pure-virtual function.
    static const Cartesian3D & tag(); // Runtime singleton for this tag.
  };
  struct Points : public ArrayDimTag {
    const char * name() const ;  // Supply the pure-virtual function.
    static const Points & tag(); // Runtime singleton for this tag.
    // NO default Size enumeration.
  };

Example of Creating an Array
Given a block of memory for the collection of points, wrap it in an Array.

  double * chunk   = ... ; // Chunk of memory from somewhere
  unsigned npoints = ... ; // containing a number of points

  Array<double,FortranOrder,Cartesian3D,Points> points( chunk , npoints );

The points array has dimension<0> set to Cartesian3D::Size and dimension<1> set to npoints. If the npoints argument where omitted then a compilation error would be generated due to the missing Points::Size enumeration.

Enumeration Type Documentation

enum PHX::ArrayOrder

Define Natural (C-language) or Fortran ordering of array dimensions. A RankZero array does not have an ordering.

Enumerator:

NaturalOrder	Use the Natural or C-language ordering for multi-dimensions where the right-most dimension is stride-one.
FortranOrder	Use the Reverse or Fortran-language ordering for multi-dimensions where the left-most dimension is stride-one.
RankZero	Special tag to indicate that an array specification has degenerated to rank-zero, i.e. is no longer an array.

Function Documentation

void PHX::array_check_index	(	const unsigned	dim,
		const unsigned	index
	)

Referenced by PHX::ArrayDimTag::to_index(), and PHX::ArrayDimTag::to_string().

Here is the caller graph for this function:

void PHX::array_check_indices	(	const bool	arg_natural,
		const unsigned	arg_rank,
		const unsigned *const	arg_stride,
		const unsigned	arg_i1,
		const unsigned	arg_i2,
		const unsigned	arg_i3,
		const unsigned	arg_i4,
		const unsigned	arg_i5,
		const unsigned	arg_i6,
		const unsigned	arg_i7,
		const unsigned	arg_i8
	)

void PHX::array_check_offset	(	const unsigned	size,
		const unsigned	test_offset
	)

Referenced by PHX::Array< Scalar, array_order, void, void, void, void, void, void, void, void >::operator[](), and PHX::Array< ScalarT, Order, Cell, Node, void, void, void, void, void, void >::operator[]().

Here is the caller graph for this function:

void PHX::array_check_ordinal	(	const unsigned	rank,
		const unsigned	test_ordinal
	)

Referenced by PHX::Array< Scalar, array_order, void, void, void, void, void, void, void, void >::dimension(), PHX::Array< ScalarT, Order, Cell, Node, void, void, void, void, void, void >::dimension(), PHX::Array< Scalar, array_order, void, void, void, void, void, void, void, void >::tag(), and PHX::Array< ScalarT, Order, Cell, Node, void, void, void, void, void, void >::tag().

Here is the caller graph for this function:

void PHX::array_check_rank	(	const unsigned	rank,
		const unsigned	test_rank
	)

Referenced by PHX::Array< Scalar, array_order, void, void, void, void, void, void, void, void >::operator()().

Here is the caller graph for this function: