Array3DShape Class Reference

#include <Array3DShape.hpp>

Collaboration diagram for Array3DShape:

[legend]

List of all members.

Public Member Functions
bool	operator== (const Array3DShape &s) const
size_t	operator() (const size_t &i, const size_t &j, const size_t &k) const
size_t	operator() (const TinyVector< 3, size_t > &index) const
const size_t &	nx () const
	Access to the first component of the shape.
const size_t &	ny () const
	Access to the second component of the shape.
const size_t &	nz () const
	Access to the third component of the shape.
const size_t &	operator[] (const size_t &i) const
size_t	size () const
	Returns the product of shape components (ie: the number of elements when tensorized).
Array3DShape	operator- (size_t i) const
Array3DShape &	operator= (const Array3DShape &s)
	Array3DShape (const size_t &i, const size_t &j, const size_t &k)
	Constructs a Array3DShape.
	Array3DShape (const TinyVector< 3, size_t > &shape)
	Array3DShape (const Array3DShape &s)
	Copy constructor.
	Array3DShape ()
	Default Constructor.
	~Array3DShape ()
Private Attributes
TinyVector< 3, size_t >	__shape
	The shape.
Friends
std::ostream &	operator<< (std::ostream &os, const Array3DShape &a)

---

Detailed Description

This class defines the shape of a 3d structure (mesh, vector, ...)

Author:

Stéphane Del Pino.

Definition at line 35 of file Array3DShape.hpp.

---

Constructor & Destructor Documentation

Array3DShape::Array3DShape	(	const size_t &	i,
		const size_t &	j,
		const size_t &	k
	)			[inline]

Constructs a Array3DShape.

Definition at line 117 of file Array3DShape.hpp.

References __shape.

  {
    __shape[0]=i;
    __shape[1]=j;
    __shape[2]=k;
  }

Array3DShape::Array3DShape

(

const TinyVector< 3, size_t > &

shape

)

[inline]

Constructs an Array3DShape by a TinyVector

Parameters:

shape

given shape

Definition at line 131 of file Array3DShape.hpp.

    : __shape(shape)
  {
    ;
  }

Array3DShape::Array3DShape

(

const Array3DShape &

s

)

[inline]

Copy constructor.

Definition at line 138 of file Array3DShape.hpp.

    : __shape(s.__shape)
  {
    ;
  }

Array3DShape::Array3DShape

(

)

[inline]

Default Constructor.

Definition at line 145 of file Array3DShape.hpp.

Referenced by operator-().

  {
    ;
  }

Array3DShape::~Array3DShape

(

)

[inline]

Definition at line 150 of file Array3DShape.hpp.

  {
    ;
  }

---

Member Function Documentation

bool Array3DShape::operator==

(

const Array3DShape &

s

)

const [inline]

Definition at line 48 of file Array3DShape.hpp.

References __shape.

  {
    return (__shape==s.__shape);
  }

size_t Array3DShape::operator()	(	const size_t &	i,
		const size_t &	j,
		const size_t &	k
	)			const [inline]

Returns the global number associated to the (i,j,k) representation

Definition at line 55 of file Array3DShape.hpp.

References __shape.

  {
    return (i*__shape[1]*__shape[2] + j*__shape[2] + k);
  }

size_t Array3DShape::operator()

(

const TinyVector< 3, size_t > &

index

)

const [inline]

Definition at line 62 of file Array3DShape.hpp.

  {
    return (*this)(index[0],index[1],index[2]);
  }

const size_t& Array3DShape::nx

(

)

const [inline]

Access to the first component of the shape.

Definition at line 69 of file Array3DShape.hpp.

References __shape.

Referenced by Structured3DVector< bool >::__buildView(), Structured3DVector< bool >::__clean(), Structured3DMesh::cellIndex(), SpectralMesh::cellIndex(), Structured3DMesh::find(), SpectralMesh::find(), MultiGrid::MultiGrid(), Structured3DMeshShape::numberOfCells(), Structured3DMeshShape::numberOfEdges(), Structured3DMeshShape::numberOfVertices(), Structured3DVector< bool >::nx(), Structured3DMeshShape::nx(), Structured3DVector< bool >::operator()(), MeshExpressionSpectral::put(), MeshExpressionStructured::put(), SpectralMesh::SpectralMesh(), Structured3DMesh::Structured3DMesh(), and MultiGrid::weightJacobi().

  {
    return __shape[0];
  }

const size_t& Array3DShape::ny

(

)

const [inline]

Access to the second component of the shape.

Definition at line 75 of file Array3DShape.hpp.

References __shape.

Referenced by Structured3DVector< bool >::__buildView(), Structured3DMesh::cellIndex(), SpectralMesh::cellIndex(), Structured3DMesh::find(), SpectralMesh::find(), MultiGrid::MultiGrid(), Structured3DMeshShape::numberOfCells(), Structured3DMeshShape::numberOfEdges(), Structured3DMeshShape::numberOfVertices(), Structured3DVector< bool >::ny(), Structured3DMeshShape::ny(), Structured3DVector< bool >::operator()(), MeshExpressionSpectral::put(), MeshExpressionStructured::put(), SpectralMesh::SpectralMesh(), Structured3DMesh::Structured3DMesh(), and MultiGrid::weightJacobi().

  {
    return __shape[1];
  }

const size_t& Array3DShape::nz

(

)

const [inline]

Access to the third component of the shape.

Definition at line 81 of file Array3DShape.hpp.

References __shape.

Referenced by Structured3DVector< bool >::__buildView(), Structured3DMesh::cellIndex(), SpectralMesh::cellIndex(), Structured3DMesh::find(), SpectralMesh::find(), MultiGrid::MultiGrid(), Structured3DMeshShape::numberOfCells(), Structured3DMeshShape::numberOfEdges(), Structured3DMeshShape::numberOfVertices(), Structured3DVector< bool >::nz(), Structured3DMeshShape::nz(), Structured3DVector< bool >::operator()(), MeshExpressionSpectral::put(), MeshExpressionStructured::put(), SpectralMesh::SpectralMesh(), Structured3DMesh::Structured3DMesh(), and MultiGrid::weightJacobi().

  {
    return __shape[2];
  }

const size_t& Array3DShape::operator[]

(

const size_t &

i

)

const [inline]

Definition at line 86 of file Array3DShape.hpp.

References __shape, and ASSERT.

  {
    ASSERT(i<3);
    return __shape[i];
  }

size_t Array3DShape::size

(

)

const [inline]

Returns the product of shape components (ie: the number of elements when tensorized).

Definition at line 93 of file Array3DShape.hpp.

References __shape.

Referenced by Structured3DVector< bool >::resize().

  {
    return __shape[0]*__shape[1]*__shape[2];
  }

Array3DShape Array3DShape::operator-

(

size_t

i

)

const [inline]

Computes the Array3DShape of an object for which 1 element is removed in each direction. Example:

Definition at line 101 of file Array3DShape.hpp.

References __shape, Array3DShape(), and ASSERT.

  {
    ASSERT ((i<__shape[0])&&(i<__shape[1])&&(i<__shape[2]));
    return Array3DShape(__shape[0]-i, __shape[1]-i, __shape[2]-i);
  }

Here is the call graph for this function:

Array3DShape& Array3DShape::operator=

(

const Array3DShape &

s

)

[inline]

Computes the Array3DShape of an object for which 1 element is removed in each direction. Example:

Definition at line 110 of file Array3DShape.hpp.

References __shape.

  {
    __shape = s.__shape;
    return *this;
  }

---

Friends And Related Function Documentation

std::ostream& operator<<	(	std::ostream &	os,
		const Array3DShape &	a
	)			[friend]

Definition at line 42 of file Array3DShape.hpp.

  {
    os << a.__shape;
    return os;
  }

---

Member Data Documentation

TinyVector<3,size_t> Array3DShape::__shape [private]

The shape.

Definition at line 39 of file Array3DShape.hpp.

Referenced by Array3DShape(), nx(), ny(), nz(), operator()(), operator-(), operator=(), operator==(), operator[](), and size().

---

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

• Array3DShape.hpp