GridUser Class Reference

GridUser contains cached variables from the grid-driver. More...

#include <gridDriver.h>

Inheritance diagram for GridUser:

Collaboration diagram for GridUser:

Public Member Functions
Int	mpiSize () const
Int	mpiRank () const
	GridUser (UniformGrid &ug)
Real &	GF (Int gf, Int m, Int n)
	Access the given grid function data.
Real &	t (Real m, Real n)
Real &	r (Real m, Real n)
void	cubicSplineShmooth (Int m, Int gf, Int lin2n, Int cub2n)
	Cubic spline smoother of a grid function.
void	applyBoundaryConditions (Int m, Int gf, Int parity)
void	smoothenGF (Int m, Int outgf, Int tmpgf, Int ingf, Int parity)
	Smooth data using a local polynomial regression.
void	smoothenGF2 (Int m, Int outgf, Int tmpgf, Int ingf, Int parity)
Protected Attributes
UniformGrid *	gridDriver
	The attached driver (available to descendants)
Int	nOffset
	Offset in the MPI world.
Int	nWorldLen
	Number of cells in the MPI world.
Int	nLen
	Number of cells in r-direction.
Int	nGhost
	Number of virtual (ghost) cells on the r-boundary.
Int	nTotal
	Total number of cells in r-direction including ghosts.
Int	mLen
	Number of cells in t-direction.
Real	delta_r
	The grid spacing accross r
Real	inv_delta_r
	1 / delta_r
Real	inv_delta_rr
	1 / delta_r^2
Private Attributes
Real *	grid
	Private access to the grid storage (not shared with descendants)

---

Detailed Description

GridUser contains cached variables from the grid-driver.

Note:

Finite differences are defined for the grid users.

Definition at line 233 of file gridDriver.h.

---

Constructor & Destructor Documentation

GridUser::GridUser

(

UniformGrid &

ug

)

[inline]

Definition at line 258 of file gridDriver.h.

        : gridDriver( &ug )
    {
        grid      = ug.get_grid ();
        nOffset   = ug.get_nOffset ();
        nWorldLen = ug.get_nWorldLen ();
        nLen      = ug.get_nLen ();
        mLen      = ug.get_mLen ();
        nGhost    = ug.get_nGhost ();
        nTotal    = ug.get_nTotal ();
        delta_r   = ug.get_delta_r ();

        // Calculate various constants involving 1/delta_r
        //
        inv_delta_r  = 1 / ug.get_delta_r ();
        inv_delta_rr = 1 / ( ug.get_delta_r () * ug.get_delta_r () );
    }

---

Member Function Documentation

void GridUser::cubicSplineShmooth	(	Int	m,
		Int	gf,
		Int	lin2n,
		Int	cub2n
	)		[inline]

Cubic spline smoother of a grid function.

Definition at line 308 of file gridDriver.h.

    {
        // The accuracy is very low at low r. Assume that a few first cells are linear.
        //
        if( lin2n > 0 )
        {
            Real dydx = delta_r * GF(gf,m,nGhost+lin2n) / r(m,nGhost+lin2n);
            for ( Int i = 0; i < lin2n; ++i ) {
                GF(gf,m,nGhost+i) = ( i + 0.5 ) * dydx;
            }
        }

        // A six-point cubic spline to smooth the region around r = 0.
        //
        if( cub2n > 0 )
        {
            static CubicSpline spline( 6 );

            Real pts[6][2] = {
                { r(m,nGhost           ),   GF(gf,m,nGhost           ) },
                { r(m,nGhost + 3       ),   GF(gf,m,nGhost + 3       ) },
                { r(m,nGhost + cub2n/2 ),   GF(gf,m,nGhost + cub2n/2 ) },
                { r(m,nGhost + cub2n-6 ),   GF(gf,m,nGhost + cub2n-6 ) },
                { r(m,nGhost + cub2n-3 ),   GF(gf,m,nGhost + cub2n-3 ) },
                { r(m,nGhost + cub2n   ),   GF(gf,m,nGhost + cub2n   ) }
            };
            spline.initialize( pts );

            for( Int i = 0; i < cub2n; ++i ) {
                GF(gf,m,nGhost+i) = spline( r(m,nGhost+i) );
            }
        }
    }

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

Access the given grid function data.

Definition at line 278 of file gridDriver.h.

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

Int GridUser::mpiRank

(

)

const [inline]

Definition at line 256 of file gridDriver.h.

{ return gridDriver->mpiRank (); }

Int GridUser::mpiSize

(

)

const [inline]

Definition at line 255 of file gridDriver.h.

{ return gridDriver->mpiSize (); }

Real& GridUser::r	(	Real	m,
		Real	n
	)

Real& GridUser::t	(	Real	m,
		Real	n
	)

---

Field Documentation

Real GridUser::delta_r [protected]

The grid spacing accross r

Definition at line 248 of file gridDriver.h.

Real* GridUser::grid [private]

Private access to the grid storage (not shared with descendants)

Definition at line 236 of file gridDriver.h.

UniformGrid* GridUser::gridDriver [protected]

The attached driver (available to descendants)

Definition at line 239 of file gridDriver.h.

Real GridUser::inv_delta_r [protected]

1 / delta_r

Definition at line 249 of file gridDriver.h.

Real GridUser::inv_delta_rr [protected]

1 / delta_r^2

Definition at line 250 of file gridDriver.h.

Int GridUser::mLen [protected]

Number of cells in t-direction.

Definition at line 246 of file gridDriver.h.

Int GridUser::nGhost [protected]

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

Definition at line 244 of file gridDriver.h.

Int GridUser::nLen [protected]

Number of cells in r-direction.

Definition at line 243 of file gridDriver.h.

Int GridUser::nOffset [protected]

Offset in the MPI world.

Definition at line 241 of file gridDriver.h.

Int GridUser::nTotal [protected]

Total number of cells in r-direction including ghosts.

Definition at line 245 of file gridDriver.h.

Int GridUser::nWorldLen [protected]

Number of cells in the MPI world.

Definition at line 242 of file gridDriver.h.

---

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

• grid/gridDriver.h