AccessorStructured< SolverType > Class Template Reference

#include <fvstg.h>

Inheritance diagram for AccessorStructured< SolverType >:

Collaboration diagram for AccessorStructured< SolverType >:

Classes
class	nDim_citerator

Public Member Functions
	AccessorStructured (const MInt *const start, const MInt *const end, const MInt *const nCells, const MInt *const stgBoxSize, MInt noGhostLayers, FvStructuredSolver< 3 > *solver, const MPI_Comm commStg)
MInt	cellIndex (const MInt i, const MInt j, const MInt k) const
MInt	cellIndex (const MInt *const ijk_) const
MInt	cellIndexBC (const MInt i, const MInt j, const MInt k) const
MInt	cellIndexBC (const MInt *const ijk_) const
MInt	start (MInt dim) const
MInt	end (MInt dim) const
MInt	domainId () const
MInt	domainId (MInt, MInt) const override
nDim_citerator	nDim_citerator_begin (const MInt *start, const MInt *end) const
nDim_citerator	nDim_citerator_begin () const
nDim_citerator	nDim_citerator_end () const
nDim_citerator	iterateSlopes ()
	Solver specific implementations of the interface defined in base class. More...
nDim_citerator	iterateSlopes_nDim_citerator_end ()
nDim_citerator	iterateB1 ()
nDim_citerator	iterateB1_nDim_citerator_end ()
nDim_citerator	iterateAll ()
nDim_citerator	iterateAll_nDim_citerator_end ()
MInt	getCellId (const nDim_citerator &it_) const
	Helper functions for nDim_citerator as declared in base class. More...
MInt	getStgId (const nDim_citerator &it_) const
MInt	getNghbr (const nDim_citerator &it_, MInt dir) const
MInt	getNghbrStg (const nDim_citerator &it_, MInt dir) const
MFloat	a_coordinate (MInt cellId, MInt dim) const override
MFloat &	a_pvariable (MInt cellId, MInt varId) override
MFloat &	UInfinity () const override
MFloat &	PInfinity () const override
MFloat &	rhoInfinity () const override
Public Member Functions inherited from Accessor< AccessorStructured< SolverType >, SolverType >
AccessorStructured< SolverType > *	d ()
virtual MFloat	a_coordinate (MInt, MInt) const=0
virtual MInt	domainId (MInt, MInt) const=0
virtual MFloat &	a_pvariable (MInt, MInt)=0
virtual MFloat &	UInfinity () const=0
virtual MFloat &	PInfinity () const=0
virtual MFloat &	rhoInfinity () const=0
MInt	sizeBC () const
MInt	sizeStg () const
nDim_citerator	iterateSlopes ()
nDim_citerator	iterateSlopes_nDim_citerator_end ()
nDim_citerator	iterateB1 ()
nDim_citerator	iterateB1_nDim_citerator_end ()
nDim_citerator	iterateAll ()
nDim_citerator	iterateAll_nDim_citerator_end ()
MInt	getCellId (const nDim_citerator &it_) const
MInt	getStgId (const nDim_citerator &it_) const
MInt	getNghbr (const nDim_citerator &it_, MInt dir) const
MInt	getNghbrStg (const nDim_citerator &it_, MInt dir) const

Private Attributes
const MInt *const	m_start
const MInt *const	m_end
const MInt *const	m_nCells
const MInt *const	m_stgBoxSize
const MInt	m_noGhostLayers
nDim_citerator	nDim_citerator_invalid

Static Private Attributes
static constexpr const MInt	map_ [6][3] = {{-1, 0, 0}, {1, 0, 0}, {0, -1, 0}, {0, 1, 0}, {0, 0, -1}, {0, 0, 1}}

Additional Inherited Members
Public Types inherited from Accessor< AccessorStructured< SolverType >, SolverType >
using	nDim_citerator = nDim_iterator_t< std::vector< MInt >::const_iterator, SolverType >
Public Attributes inherited from Accessor< AccessorStructured< SolverType >, SolverType >
SolverType *const	m_solver
MPI_Comm	m_commStg
Storage	m_stgToCellId
Storage	m_bcStgId
Storage	m_stgId
MInt	m_noBcCells
MInt	m_stgSize
Static Public Attributes inherited from Accessor< AccessorStructured< SolverType >, SolverType >
static constexpr const MInt	m_nDim
Protected Types inherited from Accessor< AccessorStructured< SolverType >, SolverType >
using	Storage = std::vector< MInt >
using	iterator = std::vector< MInt >::iterator
using	const_iterator = std::vector< MInt >::const_iterator

Detailed Description

template<class SolverType>
class AccessorStructured< SolverType >

Definition at line 333 of file fvstg.h.

Constructor & Destructor Documentation

AccessorStructured()

template<class SolverType >

AccessorStructured< SolverType >::AccessorStructured ( const MInt *const  start, const MInt *const  end, const MInt *const  nCells, const MInt *const  stgBoxSize, MInt  noGhostLayers, FvStructuredSolver< 3 > *  solver, const MPI_Comm  commStg  )

inlineexplicit

Definition at line 348 of file fvstg.h.

    : Accessor<AccessorStructured<SolverType>, SolverType>(solver, commStg),
      m_start(start),
      m_end(end),
      m_nCells(nCells),
      m_stgBoxSize(stgBoxSize),
      m_noGhostLayers(noGhostLayers) {
    /*      if (m_nDim==2) {
            m_nCells[2] = m_nCells[1];
            m_nCells[1] = m_nCells[0];
            m_nCells[0] = 1;
          }*/
 
    m_stgSize = 1;
    for(MInt d = 0; d < m_nDim; ++d) {
      m_stgSize *= m_stgBoxSize[d];
    }
 
    m_noBcCells = 1;
    for(MInt d = 0; d < m_nDim; d++) {
      const MInt nDims = m_end[d] - m_start[d];
      m_noBcCells *= nDims;
    }
 
    m_stgToCellId.resize(m_stgSize);
    MInt cnt = 0;
    for(MInt k = 0; k < m_stgBoxSize[2]; ++k) {
      for(MInt j = 0; j < m_stgBoxSize[1]; ++j) {
        for(MInt i = 0; i < m_stgBoxSize[0]; ++i) {
          m_stgToCellId[cnt++] = cellIndex(i, j, k);
        }
      }
    }
 
    m_bcStgId.resize(m_noBcCells);
    cnt = 0;
    for(MInt k = m_start[2]; k < m_end[2]; ++k) {
      for(MInt j = m_start[1]; j < m_end[1]; ++j) {
        for(MInt i = m_start[0]; i < m_end[0]; ++i) {
          m_bcStgId[cnt++] = cellIndexBC(i, j, k);
        }
      }
    }
 
    m_stgId.resize(m_stgSize);
    std::iota(std::begin(m_stgId), std::end(m_stgId), 0); // Fill with 0, 1, ..., m_stgSize-1
  }                                                       // Constructor ends

Member Function Documentation

a_coordinate()

template<class SolverType >

MFloat AccessorStructured< SolverType >::a_coordinate ( MInt  cellId, MInt  dim  ) const

inlineoverridevirtual

Implements Accessor< AccessorStructured< SolverType >, SolverType >.

Definition at line 572 of file fvstg.h.

{ return m_solver->m_cells->coordinates[dim][cellId]; }

a_pvariable()

template<class SolverType >

MFloat & AccessorStructured< SolverType >::a_pvariable ( MInt  cellId, MInt  varId  )

inlineoverridevirtual

Implements Accessor< AccessorStructured< SolverType >, SolverType >.

Definition at line 573 of file fvstg.h.

{ return m_solver->m_cells->pvariables[varId][cellId]; }

cellIndex() [1/2]

template<class SolverType >

MInt AccessorStructured< SolverType >::cellIndex ( const MInt *const  ijk_ ) const

inline

Definition at line 400 of file fvstg.h.

{ return ijk_[0] + (ijk_[1] + ijk_[2] * m_nCells[1]) * m_nCells[2]; }

cellIndex() [2/2]

template<class SolverType >

MInt AccessorStructured< SolverType >::cellIndex ( const MInt  i, const MInt  j, const MInt  k  ) const

inline

Definition at line 399 of file fvstg.h.

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

cellIndexBC() [1/2]

template<class SolverType >

MInt AccessorStructured< SolverType >::cellIndexBC ( const MInt *const  ijk_ ) const

inline

Definition at line 404 of file fvstg.h.

                                                 {
    return ijk_[0] + (ijk_[1] + ijk_[2] * m_stgBoxSize[1]) * m_stgBoxSize[2];
  }

cellIndexBC() [2/2]

template<class SolverType >

MInt AccessorStructured< SolverType >::cellIndexBC ( const MInt  i, const MInt  j, const MInt  k  ) const

inline

Definition at line 401 of file fvstg.h.

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

domainId() [1/2]

template<class SolverType >

MInt AccessorStructured< SolverType >::domainId ( ) const

inline

Definition at line 410 of file fvstg.h.

{ return m_solver->domainId(); }

domainId() [2/2]

template<class SolverType >

MInt AccessorStructured< SolverType >::domainId ( MInt  , MInt    ) const

inlineoverridevirtual

Implements Accessor< AccessorStructured< SolverType >, SolverType >.

Definition at line 411 of file fvstg.h.

{ TERMM(-1, "Invalid call!"); }

end()

template<class SolverType >

MInt AccessorStructured< SolverType >::end ( MInt  dim ) const

inline

Definition at line 408 of file fvstg.h.

{ return m_end[dim]; }

getCellId()

template<class SolverType >

MInt AccessorStructured< SolverType >::getCellId ( const nDim_citerator &  it_ ) const

inline

Definition at line 558 of file fvstg.h.

                                                  {
    assert(m_stgToCellId[*it_] == cellIndex(it_.getijk()));
    return m_stgToCellId[*it_];
  }

getNghbr()

template<class SolverType >

MInt AccessorStructured< SolverType >::getNghbr ( const nDim_citerator &  it_, MInt  dir  ) const

inline

Definition at line 565 of file fvstg.h.

                                                           {
    return cellIndex(it_.getijk(0) + map_[dir][0], it_.getijk(1) + map_[dir][1], it_.getijk(2) + map_[dir][2]);
  }

getNghbrStg()

template<class SolverType >

MInt AccessorStructured< SolverType >::getNghbrStg ( const nDim_citerator &  it_, MInt  dir  ) const

inline

Definition at line 568 of file fvstg.h.

                                                              {
    return cellIndexBC(it_.getijk(0) + map_[dir][0], it_.getijk(1) + map_[dir][1], it_.getijk(2) + map_[dir][2]);
  }

getStgId()

template<class SolverType >

MInt AccessorStructured< SolverType >::getStgId ( const nDim_citerator &  it_ ) const

inline

Definition at line 562 of file fvstg.h.

{ return *it_; }

iterateAll()

template<class SolverType >

nDim_citerator AccessorStructured< SolverType >::iterateAll ( )

inline

Definition at line 550 of file fvstg.h.

                              {
    MInt start_[3] = {0, 0, 0};
    return {this, &start_[0], m_stgBoxSize};
  }

iterateAll_nDim_citerator_end()

template<class SolverType >

nDim_citerator AccessorStructured< SolverType >::iterateAll_nDim_citerator_end ( )

inline

Definition at line 555 of file fvstg.h.

{ return nDim_citerator_invalid; }

iterateB1()

template<class SolverType >

nDim_citerator AccessorStructured< SolverType >::iterateB1 ( )

inline

Definition at line 541 of file fvstg.h.

                             {
    MInt ii = m_noGhostLayers - 1;
    MInt start_[3] = {ii, m_start[1], m_start[2]};
    MInt end_[3] = {ii + 1, m_end[1], m_end[2]};
    return {this, &start_[0], &end_[0]};
  }

iterateB1_nDim_citerator_end()

template<class SolverType >

nDim_citerator AccessorStructured< SolverType >::iterateB1_nDim_citerator_end ( )

inline

Definition at line 548 of file fvstg.h.

{ return nDim_citerator_invalid; }

iterateSlopes()

template<class SolverType >

nDim_citerator AccessorStructured< SolverType >::iterateSlopes ( )

inline

Definition at line 532 of file fvstg.h.

                                 {
    MInt ii = 1;
    MInt start_[3] = {ii, m_start[1] + 1, m_start[2] + 1};
    MInt end_[3] = {ii + 1, m_end[1] - 1, m_end[2] - 1};
    return {this, &start_[0], &end_[0]};
  }

iterateSlopes_nDim_citerator_end()

template<class SolverType >

nDim_citerator AccessorStructured< SolverType >::iterateSlopes_nDim_citerator_end ( )

inline

Definition at line 539 of file fvstg.h.

{ return nDim_citerator_invalid; }

nDim_citerator_begin() [1/2]

template<class SolverType >

nDim_citerator AccessorStructured< SolverType >::nDim_citerator_begin ( ) const

inline

Definition at line 527 of file fvstg.h.

{ return {this, m_start, m_end}; }

nDim_citerator_begin() [2/2]

template<class SolverType >

nDim_citerator AccessorStructured< SolverType >::nDim_citerator_begin ( const MInt *  start, const MInt *  end  ) const

inline

Definition at line 526 of file fvstg.h.

{ return {this, start, end}; }

nDim_citerator_end()

template<class SolverType >

nDim_citerator AccessorStructured< SolverType >::nDim_citerator_end ( ) const

inline

Definition at line 528 of file fvstg.h.

{ return nDim_citerator_invalid; }

PInfinity()

template<class SolverType >

MFloat & AccessorStructured< SolverType >::PInfinity ( ) const

inlineoverridevirtual

Implements Accessor< AccessorStructured< SolverType >, SolverType >.

Definition at line 575 of file fvstg.h.

{ return m_solver->PV->PInfinity; }

rhoInfinity()

template<class SolverType >

MFloat & AccessorStructured< SolverType >::rhoInfinity ( ) const

inlineoverridevirtual

Implements Accessor< AccessorStructured< SolverType >, SolverType >.

Definition at line 576 of file fvstg.h.

{ return m_solver->CV->rhoInfinity; }

start()

template<class SolverType >

MInt AccessorStructured< SolverType >::start ( MInt  dim ) const

inline

Definition at line 407 of file fvstg.h.

{ return m_start[dim]; }

UInfinity()

template<class SolverType >

MFloat & AccessorStructured< SolverType >::UInfinity ( ) const

inlineoverridevirtual

Implements Accessor< AccessorStructured< SolverType >, SolverType >.

Definition at line 574 of file fvstg.h.

{ return m_solver->PV->UInfinity; }

Member Data Documentation

m_end

template<class SolverType >

const MInt* const AccessorStructured< SolverType >::m_end

private

Definition at line 582 of file fvstg.h.

m_nCells

template<class SolverType >

const MInt* const AccessorStructured< SolverType >::m_nCells

private

Definition at line 584 of file fvstg.h.

m_noGhostLayers

template<class SolverType >

const MInt AccessorStructured< SolverType >::m_noGhostLayers

private

Definition at line 587 of file fvstg.h.

m_start

template<class SolverType >

const MInt* const AccessorStructured< SolverType >::m_start

private

Definition at line 580 of file fvstg.h.

m_stgBoxSize

template<class SolverType >

const MInt* const AccessorStructured< SolverType >::m_stgBoxSize

private

Definition at line 586 of file fvstg.h.

map_

template<class SolverType >

constexpr const MInt AccessorStructured< SolverType >::map_[6][3] = {{-1, 0, 0}, {1, 0, 0}, {0, -1, 0}, {0, 1, 0}, {0, 0, -1}, {0, 0, 1}}

staticconstexprprivate

Definition at line 591 of file fvstg.h.

nDim_citerator_invalid

template<class SolverType >

nDim_citerator AccessorStructured< SolverType >::nDim_citerator_invalid

private

Definition at line 589 of file fvstg.h.

---

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

• /home/gitlab-runner/scratch/builds/oxpnswJ6/1/aia/m-AIA/m-AIA/src/FV/fvstg.h