Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
ylee88 committed Jul 11, 2024
1 parent 09e1a22 commit b02b0a5
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 21 deletions.
10 changes: 0 additions & 10 deletions includes/Milhoja_TileFlashxr.h
Original file line number Diff line number Diff line change
Expand Up @@ -15,16 +15,6 @@

namespace milhoja {

/**
* \brief Fully-implemented Tile class for use with AMReX.
*
* \todo lo/hi -> interiorBox(lo, hi)
* \todo loGC/hiGC -> dataArrayBox(lo, hi)
* \todo need grownTileBox as well.
*
* Contains a reference to the multifab for the appropriate level
* so pointers into it can be returned.
*/
class TileFlashxr
: public Tile
{
Expand Down
19 changes: 8 additions & 11 deletions src/Milhoja_TileFlashxr.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -21,17 +21,14 @@ namespace milhoja {
* \todo Include a single metadata routine that gets gId, level, lo/hi, and
* loGC/hiGC in one call? This could replace the lo(int*), etc. calls.
*
* \param level The 0-based refinement level of the tile
* \param gridIdx The integer index for the block that contains the tile
* \param tileIdx The local integer index for the tile in its block
* \param interior The lo/hi global indices of the tile's interior cells
* \param dataArray The lo/hi global indices of the tile's cell-centered data array
* \param unkBlkPtr The FAB containing the cell-centered data at the given
* level
* \param fluxBlkPtrs A vector of pointers to the FABs that store the
* face-centered flux data at the given level. If there are
* no flux variables for the problem, this vector should be
* empty. Otherwise, it should have MILHOJA_NDIM elements.
* \note Refer Milhoja_FlashxrTileRaw.h
*
* \param tP The struct that has raw pointers for constructing Flash-X tileDesc
* e.g.) Unk, FLUX[XYZ]
* \param tI The struct that has integer variables for constructing Flash-X tileDesc
* e.g.) level, tileIdx, ...
* \param tR The struct that has real variables for constructing Flash-X tileDesc
* e.g.) delta[XYZ]
*/
TileFlashxr::TileFlashxr(const FlashxrTileRawPtrs tP,
const FlashxTileRawInts tI,
Expand Down

0 comments on commit b02b0a5

Please sign in to comment.