Uniform grid of grid functions. More...

#include <gridDriver.h>

Inheritance diagram for UniformGrid:

Collaboration diagram for UniformGrid:

Public Member Functions
Real *	get_grid ()
Int	get_nOffset () const
Int	get_nWorldLen () const
Int	get_nLen () const
Int	get_nGhost () const
Int	get_nTotal () const
Int	get_mLen () const
Real	get_delta_r () const
Int	mpiSize () const
Int	mpiRank () const
	UniformGrid (Parameters &params)
	Constructs the uniform grid as specified in the parameter file.
Real &	GF (Int gf, Int m, Int n)
	Access the given grid function data.
bool	exchangeBoundaries (Int m, bool receiveEdges=true)
	Exchange the boundaries at the given time slice.
void	abortExchange ()
	Nonblocking signal to all the ranks that we are quitting integration.
Protected Attributes
Real *	grid
	The grid storage.
Int	nOffset
	Offset in the MPI world.
Int	nWorldLen
	Number of cells in the MPI world.
Int	nLen
	Number of our cells in `r`-direction.
Int	nGhost
	Number of virtual (ghost) cells on the `r`-boundary.
Int	nTotal
	Total number of `r`-cells (`nTotal = nLen + 2 * nGhost`)
Real	delta_r
	The grid spacing accross `r`
Int	mLen
	Number of cached cells in `t`-direction.
Int	mExtra
	Number of extra cells (for integration substeps)
Private Member Functions
void	createGrid ()
	Allocates memory for the numerical grid.
void	deleteGrid ()
	Releases memory allocated for the numerical grid.

Detailed Description

Uniform grid of grid functions.

Definition at line 70 of file gridDriver.h.

Constructor & Destructor Documentation

UniformGrid::UniformGrid ( Parameters & params ) [inline]

Constructs the uniform grid as specified in the parameter file.

Split the data equally among all the ranks in the MPI world

The last in rank gets 'all the rest'

Sanity check that nGhost > CFDS_ORDER/2

Allocate memory for the grid

Configure MPI ghost chunk datatype

Warning:: Using fld::mpiBoundary to split GFs works only if the grid index is organized as (<m> * GFCNT + <gf> ) * nTotal + <n>. Replace fld::mpiBoundary by GFCNT to exchange all the GFs.

Definition at line 134 of file gridDriver.h.

    {
        if ( ! isFirstInRank () ) {
            slog.disabled = true; // only the first in rank can access the output
        }

        params.get( "grid.nLen",    nWorldLen, 10  );
        params.get( "grid.nGhost",  nGhost,    10  );
        params.get( "grid.delta_r", delta_r,   0.1 );
        params.get( "grid.mLen",    mLen,      5   );
        params.get( "grid.mExtra",  mExtra,    9   );

        /// - Split the data equally among all the ranks in the MPI world
        ///
        nLen = nWorldLen / mpiSize();
        nOffset = mpiRank() * nLen; // Seek offset in the MPI world

        /// - The last in rank gets 'all the rest'
        ///
        if ( mpiRank() == mpiSize() - 1 && mpiSize() > 1 ) {
            nLen += ( nWorldLen % mpiSize() );
        }

        nTotal = nLen + 2 * nGhost;

        slog << "Uniform Grid Driver:" << std::endl << std::endl
             << "    nLen = " << nLen << ",  nGhost = " << nGhost
             << ",  delta_r = " << delta_r
             << ",  mLen = " << mLen << ",  mExtra = " << mExtra << std::endl
             << "    Compile-time: CFDS_ORDER = " << CFDS_ORDER << std::endl;

        #if _OPENMP
            if ( mpiSize() > 1 ) {
                omp_set_num_threads( 1 ); /// @todo make omp.nthreads configurable
            }
            slog << "    Using OpenMP: #procs = "
                 << omp_get_num_procs() << ", max #threads = "
                 << omp_get_max_threads() << std::endl;
        #endif

        if ( mpiSize() > 1 ) {
             slog << "    Using MPI: world size = " << mpiSize()
                  << ",  sum of world's nLen " << nWorldLen << ",  nOffset = " << nOffset
                  << std::endl;
        }

        /// - Sanity check that nGhost > CFDS_ORDER/2
        ///
        if( nGhost < CFDS_ORDER/2 ) {
            slog << "Error: Ghost region does not fit the FD order." << std::endl;
            quit( -1 );
        }

        /// - Allocate memory for the grid
        ///
        createGrid ();

        /// - Configure MPI ghost chunk datatype
        ///
        /// @warning  Using fld::mpiBoundary to split GFs works only if the grid index
        ///           is organized as `(<m> * GFCNT + <gf> ) * nTotal + <n>`.
        ///           Replace fld::mpiBoundary by GFCNT to exchange all the GFs.
        ///
        defineGhostChunk( fld::mpiBoundary + 1, nTotal, nGhost );
    }

Member Function Documentation

void UniformGrid::abortExchange ( ) [inline]

Nonblocking signal to all the ranks that we are quitting integration.

Definition at line 222 of file gridDriver.h.

    {
        MPIWorld::abortExchange( /* dummy data */ &GF( fld::t, 0, 0 ) );
    }

void UniformGrid::createGrid ( ) [inline, private]

Allocates memory for the numerical grid.

We allocate mExtra extra m grid rows for the intermediate steps. We also allocate 2*nGhost n-cells as the L/R spatial boundary.

Definition at line 78 of file gridDriver.h.

    {
        size_t mDim = mLen + mExtra;
        grid = new Real[ mDim * nTotal * GFCNT ];
        std::fill_n( grid, mDim * nTotal * GFCNT, NAN );

        slog << "    Allocated " << mDim << " * " << nTotal
             << " * " << GFCNT
             << " * Real" << 8 * sizeof(Real)
             << " = " << mDim * nTotal * GFCNT
             << " bytes" << std::endl
             << "    Tracking " << GFCNT << " grid functions at a point"
             << std::endl << std::endl;
    }

void UniformGrid::deleteGrid ( ) [inline, private]

Releases memory allocated for the numerical grid.

Definition at line 95 of file gridDriver.h.

    {
        if ( grid != NULL ) {
            delete[] grid;
            grid = NULL;
        }
    }

bool UniformGrid::exchangeBoundaries	(	Int	m,
		bool	receiveEdges = `true`
	)		`[inline]`

Exchange the boundaries at the given time slice.

Definition at line 208 of file gridDriver.h.

    {
        Real* timeSlice = &GF( fld::t, m, 0 );
        return MPIWorld::exchangeBoundaries(
            timeSlice,                           // Left ghost  (received)
            timeSlice + nGhost,                  // Left edge   (sent)
            timeSlice + nGhost + nLen - nGhost,  // Right_edge  (sent)
            timeSlice + nGhost + nLen,           // Right ghost (received)
            receiveEdges  // True if to receive the edges (otherwise just send ghosts)
        );
    }

Real UniformGrid::get_delta_r ( ) const [inline]

Definition at line 127 of file gridDriver.h.

{ return delta_r;   }

Real* UniformGrid::get_grid ( ) [inline]

Definition at line 119 of file gridDriver.h.

{ return grid; }

Int UniformGrid::get_mLen ( ) const [inline]

Definition at line 126 of file gridDriver.h.

{ return mLen;      }

Int UniformGrid::get_nGhost ( ) const [inline]

Definition at line 124 of file gridDriver.h.

{ return nGhost;    }

Int UniformGrid::get_nLen ( ) const [inline]

Definition at line 123 of file gridDriver.h.

{ return nLen;      }

Int UniformGrid::get_nOffset ( ) const [inline]

Definition at line 121 of file gridDriver.h.

{ return nOffset;   }

Int UniformGrid::get_nTotal ( ) const [inline]

Definition at line 125 of file gridDriver.h.

{ return nTotal;    }

Int UniformGrid::get_nWorldLen ( ) const [inline]

Definition at line 122 of file gridDriver.h.

{ return nWorldLen; }

Real& UniformGrid::GF	(	Int	gf,
		Int	m,
		Int	n
	)		`[inline]`

Access the given grid function data.

Definition at line 202 of file gridDriver.h.

                                            {
        return  grid[ (m * GFCNT + gf ) * nTotal + n ];
    }

Int UniformGrid::mpiRank ( ) const [inline]

Definition at line 130 of file gridDriver.h.

{ return rank ();   }

Int UniformGrid::mpiSize ( ) const [inline]

Definition at line 129 of file gridDriver.h.

{ return size ();   }

Field Documentation

Real UniformGrid::delta_r [protected]

The grid spacing accross r

Definition at line 112 of file gridDriver.h.

Real* UniformGrid::grid [protected]

The grid storage.

Definition at line 105 of file gridDriver.h.

Int UniformGrid::mExtra [protected]

Number of extra cells (for integration substeps)

Definition at line 115 of file gridDriver.h.

Int UniformGrid::mLen [protected]

Number of cached cells in t-direction.

Definition at line 114 of file gridDriver.h.

Int UniformGrid::nGhost [protected]

Number of virtual (ghost) cells on the r-boundary.

Definition at line 110 of file gridDriver.h.

Int UniformGrid::nLen [protected]

Number of our cells in r-direction.

Definition at line 109 of file gridDriver.h.

Int UniformGrid::nOffset [protected]

Offset in the MPI world.

Definition at line 107 of file gridDriver.h.

Int UniformGrid::nTotal [protected]

Total number of r-cells (nTotal = nLen + 2 * nGhost)

Definition at line 111 of file gridDriver.h.

Int UniformGrid::nWorldLen [protected]

Number of cells in the MPI world.

Definition at line 108 of file gridDriver.h.

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

grid/gridDriver.h

Public Member Functions

Protected Attributes

Private Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Field Documentation