Skip to content

Commit

Permalink
Delete empty below comments on classes and functions (AMReX-Codes#3669)
Browse files Browse the repository at this point in the history
Deleting the empty lines between the Doxygen comments and the class
declarations makes Intellisense actually recognize the connections.
  • Loading branch information
eebasso authored Dec 14, 2023
1 parent b903e88 commit d988c98
Show file tree
Hide file tree
Showing 50 changed files with 29 additions and 98 deletions.
1 change: 0 additions & 1 deletion Src/Amr/AMReX_Amr.H
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,6 @@ class AmrInSituBridge;
* not belong on a single level, like establishing and updating the hierarchy
* of levels, global timestepping, and managing the different AmrLevels
*/

class Amr
: public AmrCore
{
Expand Down
1 change: 0 additions & 1 deletion Src/Amr/AMReX_AmrLevel.H
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,6 @@ class TagBoxArray;
* AmrLevel functions both as a container for state data on a level
* and also manages the advancement of data in time.
*/

class AmrLevel
{
friend class Amr;
Expand Down
2 changes: 0 additions & 2 deletions Src/Amr/AMReX_Derive.H
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,6 @@ class DescriptorList;
* from the state data contained in AmrLevel and its derivatives. Some
* examples might be kinetic energy, vorticity, concentration gradients ...
*/

class DeriveRec
{
friend class DeriveList;
Expand Down Expand Up @@ -339,7 +338,6 @@ private:
*
* DeriveList manages and provides access to the list of DeriveRecs.
*/

class DeriveList
{
public:
Expand Down
1 change: 0 additions & 1 deletion Src/Amr/AMReX_LevelBld.H
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,6 @@ namespace amrex {
* Abstract base class specifying an interface for building problem-specific
* AmrLevels.
*/

class LevelBld
{
public:
Expand Down
1 change: 0 additions & 1 deletion Src/Amr/AMReX_StateData.H
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,6 @@ class StateDataPhysBCFunct;
*
* StateData holds state data on a level for the current and previous time step.
*/

class StateData
{
friend class StateDataPhysBCFunct;
Expand Down
2 changes: 0 additions & 2 deletions Src/Amr/AMReX_StateDescriptor.H
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,6 @@ namespace amrex {
/**
* \brief Attributes of StateData.
*/

class StateDescriptor
{
friend class DescriptorList;
Expand Down Expand Up @@ -434,7 +433,6 @@ private:
*
* A container class for StateDescriptors.
*/

class DescriptorList
{
public:
Expand Down
1 change: 0 additions & 1 deletion Src/AmrCore/AMReX_AmrCore.H
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,6 @@ class AmrParGDB;
* virtual functions to allocate, initialize and delete data. It also
* requires the derived class to tag cells for refinement.
*/

class AmrCore
: public AmrMesh
{
Expand Down
2 changes: 0 additions & 2 deletions Src/AmrCore/AMReX_Cluster.H
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,6 @@ class ClusterList;
*
* Utility class for tagging error cells.
*/

class Cluster
{
public:
Expand Down Expand Up @@ -138,7 +137,6 @@ private:
*
* A container class for Cluster.
*/

class ClusterList
{
public:
Expand Down
2 changes: 0 additions & 2 deletions Src/AmrCore/AMReX_ErrorList.H
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,6 @@ extern "C"
* actual error tagging will be through derivation, so provision is made
* for this as well.
*/

class ErrorRec
{
public:
Expand Down Expand Up @@ -348,7 +347,6 @@ private:
*
* Container class for ErrorRecs.
*/

class ErrorList
{
public:
Expand Down
1 change: 0 additions & 1 deletion Src/AmrCore/AMReX_FillPatcher.H
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,6 @@ namespace amrex {
* See AmrLevel::RK for an example of using the RungeKutta functions and
* FillPatcher together.
*/

template <class MF = MultiFab>
class FillPatcher
{
Expand Down
1 change: 0 additions & 1 deletion Src/AmrCore/AMReX_FluxRegister.H
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,6 @@ namespace amrex {
*
* Stores and manipulates fluxes at coarse-fine interfaces.
*/

class FluxRegister
:
public BndryRegister
Expand Down
1 change: 0 additions & 1 deletion Src/AmrCore/AMReX_InterpFaceRegister.H
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,6 @@ namespace amrex {
* \brief InterpFaceRegister is a coarse/fine boundary register for
* interpolation of face data at the coarse/fine boundary.
*/

class InterpFaceRegister
{
public:
Expand Down
11 changes: 0 additions & 11 deletions Src/AmrCore/AMReX_Interpolater.H
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,6 @@ class IArrayBox;
*
* Specifies interpolater interface for coarse-to-fine interpolation in space.
*/

class Interpolater
: public InterpBase
{
Expand Down Expand Up @@ -160,7 +159,6 @@ public:
*
* Bilinear interpolation on node centered data.
*/

class NodeBilinear
:
public Interpolater
Expand Down Expand Up @@ -219,7 +217,6 @@ public:
*
* Bilinear interpolation on cell centered data.
*/

class CellBilinear
:
public Interpolater
Expand Down Expand Up @@ -286,7 +283,6 @@ public:
* sum_ivar a(ic,jc,ivar)*fab(if,jf,ivar) = 0 is satisfied
* in all fine cells if,jf covering coarse cell ic,jc.
*/

class CellConservativeLinear
:
public Interpolater
Expand Down Expand Up @@ -344,7 +340,6 @@ protected:
* Linear conservative interpolation on cell centered data
* but with protection against undershoots or overshoots.
*/

class CellConservativeProtected
:
public CellConservativeLinear
Expand Down Expand Up @@ -393,7 +388,6 @@ public:
*
* Quadratic interpolation on cell centered data.
*/

class CellQuadratic
:
public Interpolater
Expand Down Expand Up @@ -451,7 +445,6 @@ public:
/**
* \brief Piecewise Constant interpolation on cell centered data.
*/

class PCInterp
:
public Interpolater
Expand Down Expand Up @@ -512,7 +505,6 @@ public:
* in constructing the polynomial, the average of the polynomial inside that
* cell is equal to the cell averaged value of the original data.
*/

class CellConservativeQuartic
:
public Interpolater
Expand Down Expand Up @@ -574,7 +566,6 @@ public:
* a given coarse cell will have the same divergence, even when the coarse
* grid divergence is spatially varying.
*/

class FaceDivFree
:
public Interpolater
Expand Down Expand Up @@ -667,7 +658,6 @@ public:
*
* Bilinear interpolation on data.
*/

class FaceLinear
:
public Interpolater
Expand Down Expand Up @@ -789,7 +779,6 @@ public:
*
* Quartic interpolation on cell centered data.
*/

class CellQuartic
:
public Interpolater
Expand Down
2 changes: 0 additions & 2 deletions Src/AmrCore/AMReX_TagBox.H
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,6 @@ namespace amrex {
*
* This class is used to tag cells in a Box that need addition refinement.
*/

class TagBox final
:
public BaseFab<char>
Expand Down Expand Up @@ -145,7 +144,6 @@ public:
*
* A container class for TagBoxes.
*/

class TagBoxArray
:
public FabArray<TagBox>
Expand Down
1 change: 0 additions & 1 deletion Src/Base/AMReX_Arena.H
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,6 @@ struct ArenaInfo
* A virtual base class for objects that manage their own dynamic
* memory allocation.
*/

class Arena
{
public:
Expand Down
1 change: 0 additions & 1 deletion Src/Base/AMReX_BArena.H
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,6 @@ namespace amrex {
* This is the simplest dynamic memory management class derived from Arena.
* Makes calls to std::malloc and std::free.
*/

class BArena
:
public Arena
Expand Down
5 changes: 2 additions & 3 deletions Src/Base/AMReX_BCRec.H
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,9 @@ namespace amrex {
/**
* \brief Boundary Condition Records.
* Necessary information and functions for computing boundary conditions.
*
* This class has standard layout. And we should keep it so!
*/

// This class has standard layout. And we should keep it so!

class BCRec
{
public:
Expand Down
1 change: 0 additions & 1 deletion Src/Base/AMReX_BaseFab.H
Original file line number Diff line number Diff line change
Expand Up @@ -3528,7 +3528,6 @@ BaseFab<T>::protected_divide (const BaseFab<T>& src, const Box& srcbox, const Bo
* and stored in component comp of this FAB.
* This fab is returned as a reference for chaining.
*/

template <class T>
template <RunOn run_on>
BaseFab<T>&
Expand Down
8 changes: 3 additions & 5 deletions Src/Base/AMReX_BoxDomain.H
Original file line number Diff line number Diff line change
Expand Up @@ -55,14 +55,12 @@ std::ostream& operator<< (std::ostream& os, const BoxDomain& bd);

/**
* \brief A List of Disjoint Boxes.
*
* A BoxDomain is a BoxList with the restriction that Boxes in the list
* are disjoint.
* Note that a BoxDomain is NOT a BoxList due to the protected inheritance.
* This is a concrete class, not a polymorphic one.
*/

//Note that a BoxDomain is NOT a BoxList due to the protected inheritance.
//This is a concrete class, not a polymorphic one.


class BoxDomain
:
protected BoxList
Expand Down
1 change: 0 additions & 1 deletion Src/Base/AMReX_BoxList.H
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,6 @@ namespace amrex
* IndexType. This class implements operations for sets of Boxes.
* This is a concrete class, not a polymorphic one.
*/

class BoxList
{
public:
Expand Down
1 change: 0 additions & 1 deletion Src/Base/AMReX_CArena.H
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,6 @@ struct MemStat;
* chunks of heap space and apportions it out as requested. It merges
* together neighboring chunks on each free().
*/

class CArena
:
public Arena
Expand Down
1 change: 0 additions & 1 deletion Src/Base/AMReX_CoordSys.H
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,6 @@ class FArrayBox;
*
* Routines for mapping between physical coordinate system and index space.
*/

class CoordSys
{
public:
Expand Down
1 change: 0 additions & 1 deletion Src/Base/AMReX_DistributionMapping.H
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,6 @@ class FabArrayBase;
* BoxArray are as equal across CPUs as is possible. The SFC distribution is
* based on a space filling curve.
*/

class DistributionMapping
{
public:
Expand Down
1 change: 0 additions & 1 deletion Src/Base/AMReX_FACopyDescriptor.H
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,6 @@ FabCopyDescriptor<FAB>::~FabCopyDescriptor ()
* \brief This class orchestrates filling a destination fab of size destFabBox
* from fabarray on the local processor (myProc).
*/

template <class FAB>
class FabArrayCopyDescriptor
{
Expand Down
1 change: 0 additions & 1 deletion Src/Base/AMReX_FPC.H
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,6 @@ namespace amrex {
* namespaces, and we don't like global constants, we make them static
* constant data members of this class.
*/

class FPC
{
public:
Expand Down
16 changes: 8 additions & 8 deletions Src/Base/AMReX_Geometry.H
Original file line number Diff line number Diff line change
Expand Up @@ -16,14 +16,6 @@
#include <map>

namespace amrex {
/**
* \class Geometry
* \brief Rectangular problem domain geometry.
*
* This class describes problem domain and coordinate system for
* RECTANGULAR problem domains. Since the problem domain is RECTANGULAR,
* periodicity is meaningful.
*/

class MultiFab;
class DistributionMapping;
Expand Down Expand Up @@ -67,6 +59,14 @@ public:
int coord;
};

/**
* \class Geometry
* \brief Rectangular problem domain geometry.
*
* This class describes problem domain and coordinate system for
* RECTANGULAR problem domains. Since the problem domain is RECTANGULAR,
* periodicity is meaningful.
*/
class Geometry
:
public CoordSys
Expand Down
1 change: 0 additions & 1 deletion Src/Base/AMReX_IArrayBox.H
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,6 @@ public:
* This class does NOT provide a copy constructor or assignment operator.
*/

class IArrayBox
:
public BaseFab<int>
Expand Down
1 change: 0 additions & 1 deletion Src/Base/AMReX_IndexType.H
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,6 @@ namespace amrex {
* enumerated type CellIndex to be either CELL or NODE; i.e. each of the
* AMREX_SPACEDIM dimensions must be either CELL or NODE.
*/

class IndexType
{
friend MPI_Datatype ParallelDescriptor::Mpi_typemap<IndexType>::type();
Expand Down
1 change: 0 additions & 1 deletion Src/Base/AMReX_IntVect.H
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,6 @@ int coarsen (int i, int ratio) noexcept
* C++ array. In addition, the basic arithmetic operators have been overloaded
* to implement scaling and translation operations.
*/

class IntVect
{
friend MPI_Datatype ParallelDescriptor::Mpi_typemap<IntVect>::type();
Expand Down
Loading

0 comments on commit d988c98

Please sign in to comment.