Canoe
Comprehensive Atmosphere N' Ocean Engine
Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes | List of all members
Diagnostics Class Reference

#include <diagnostics.hpp>

Inheritance diagram for Diagnostics:
[legend]

Public Member Functions

 Diagnostics (MeshBlock *pmb, ParameterInput *pin)
 
 Diagnostics (MeshBlock *pmb, std::string name)
 
virtual ~Diagnostics ()
 
Diagnostics * operator[] (std::string name)
 
template<typename Dg >
Diagnostics * AddDiagnostics (Dg const &d)
 
virtual void Progress (AthenaArray< Real > const &w)
 
virtual void Finalize (AthenaArray< Real > const &w)
 

Public Attributes

std::string myname
 
std::string type
 
std::string grid
 
std::string varname
 
std::string long_name
 
std::string units
 
Diagnostics * prev
 
Diagnostics * next
 
AthenaArray< Real > data
 
int ncycle
 

Protected Member Functions

void setColor_ (int *color, CoordinateDirection dir)
 
void gatherAllData23_ (AthenaArray< Real > &total_vol, AthenaArray< Real > &total_data)
 

Protected Attributes

MeshBlock * pmy_block_
 
int ncells1_
 
int ncells2_
 
int ncells3_
 
AthenaArray< Real > mean_
 mean and eddy component More...
 
AthenaArray< Real > eddy_
 
std::vector< int > color_
 MPI color of each rank. More...
 
std::vector< int > brank_
 rank of the bottom block More...
 
AthenaArray< Real > x1area_
 scratch geometric arrays More...
 
AthenaArray< Real > x2area_
 
AthenaArray< Real > x2area_p1_
 
AthenaArray< Real > x3area_
 
AthenaArray< Real > x3area_p1_
 
AthenaArray< Real > vol_
 
AthenaArray< Real > total_vol_
 
AthenaArray< Real > x1edge_
 
AthenaArray< Real > x1edge_p1_
 
AthenaArray< Real > x2edge_
 
AthenaArray< Real > x2edge_p1_
 
AthenaArray< Real > x3edge_
 
AthenaArray< Real > x3edge_p1_
 

Detailed Description

Definition at line 13 of file diagnostics.hpp.

Constructor & Destructor Documentation

◆ Diagnostics() [1/2]

Diagnostics::Diagnostics ( MeshBlock *  pmb,
ParameterInput *  pin 
)

Definition at line 13 of file diagnostics.cpp.

◆ Diagnostics() [2/2]

Diagnostics::Diagnostics ( MeshBlock *  pmb,
std::string  name 
)

Definition at line 79 of file diagnostics.cpp.

◆ ~Diagnostics()

Diagnostics::~Diagnostics ( )
virtual

Definition at line 120 of file diagnostics.cpp.

Member Function Documentation

◆ operator[]()

Diagnostics * Diagnostics::operator[] ( std::string  name)

Definition at line 125 of file diagnostics.cpp.

◆ AddDiagnostics()

template<typename Dg >
Diagnostics* Diagnostics::AddDiagnostics ( Dg const &  d)
inline

Definition at line 30 of file diagnostics.hpp.

◆ Progress()

virtual void Diagnostics::Progress ( AthenaArray< Real > const &  w)
inlinevirtual

Reimplemented in RadiativeFlux, HydroFlux, EddyFlux, and HydroMean.

Definition at line 40 of file diagnostics.hpp.

◆ Finalize()

virtual void Diagnostics::Finalize ( AthenaArray< Real > const &  w)
inlinevirtual

Reimplemented in Tendency, EddyKineticEnergy, AngularMomentum, RadiativeFlux, Buoyancy, HorizontalDivergence, HydroFlux, EddyFlux, PressureAnomaly, TemperatureAnomaly, HydroMean, Curl, and Divergence.

Definition at line 41 of file diagnostics.hpp.

◆ setColor_()

void Diagnostics::setColor_ ( int *  color,
CoordinateDirection  dir 
)
protected

Definition at line 134 of file diagnostics.cpp.

◆ gatherAllData23_()

void Diagnostics::gatherAllData23_ ( AthenaArray< Real > &  total_vol,
AthenaArray< Real > &  total_data 
)
protected

Definition at line 185 of file diagnostics.cpp.

Member Data Documentation

◆ myname

std::string Diagnostics::myname

Definition at line 16 of file diagnostics.hpp.

◆ type

std::string Diagnostics::type

Definition at line 16 of file diagnostics.hpp.

◆ grid

std::string Diagnostics::grid

Definition at line 16 of file diagnostics.hpp.

◆ varname

std::string Diagnostics::varname

Definition at line 17 of file diagnostics.hpp.

◆ long_name

std::string Diagnostics::long_name

Definition at line 17 of file diagnostics.hpp.

◆ units

std::string Diagnostics::units

Definition at line 17 of file diagnostics.hpp.

◆ prev

Diagnostics* Diagnostics::prev

Definition at line 18 of file diagnostics.hpp.

◆ next

Diagnostics * Diagnostics::next

Definition at line 18 of file diagnostics.hpp.

◆ data

AthenaArray<Real> Diagnostics::data

Definition at line 19 of file diagnostics.hpp.

◆ ncycle

int Diagnostics::ncycle

Definition at line 20 of file diagnostics.hpp.

◆ pmy_block_

MeshBlock* Diagnostics::pmy_block_
protected

Definition at line 44 of file diagnostics.hpp.

◆ ncells1_

int Diagnostics::ncells1_
protected

Definition at line 45 of file diagnostics.hpp.

◆ ncells2_

int Diagnostics::ncells2_
protected

Definition at line 45 of file diagnostics.hpp.

◆ ncells3_

int Diagnostics::ncells3_
protected

Definition at line 45 of file diagnostics.hpp.

◆ mean_

AthenaArray<Real> Diagnostics::mean_
protected

mean and eddy component

Definition at line 48 of file diagnostics.hpp.

◆ eddy_

AthenaArray<Real> Diagnostics::eddy_
protected

Definition at line 48 of file diagnostics.hpp.

◆ color_

std::vector<int> Diagnostics::color_
protected

MPI color of each rank.

Definition at line 51 of file diagnostics.hpp.

◆ brank_

std::vector<int> Diagnostics::brank_
protected

rank of the bottom block

Definition at line 53 of file diagnostics.hpp.

◆ x1area_

AthenaArray<Real> Diagnostics::x1area_
protected

scratch geometric arrays

Definition at line 56 of file diagnostics.hpp.

◆ x2area_

AthenaArray<Real> Diagnostics::x2area_
protected

Definition at line 56 of file diagnostics.hpp.

◆ x2area_p1_

AthenaArray<Real> Diagnostics::x2area_p1_
protected

Definition at line 56 of file diagnostics.hpp.

◆ x3area_

AthenaArray<Real> Diagnostics::x3area_
protected

Definition at line 56 of file diagnostics.hpp.

◆ x3area_p1_

AthenaArray<Real> Diagnostics::x3area_p1_
protected

Definition at line 56 of file diagnostics.hpp.

◆ vol_

AthenaArray<Real> Diagnostics::vol_
protected

Definition at line 56 of file diagnostics.hpp.

◆ total_vol_

AthenaArray<Real> Diagnostics::total_vol_
protected

Definition at line 57 of file diagnostics.hpp.

◆ x1edge_

AthenaArray<Real> Diagnostics::x1edge_
protected

Definition at line 58 of file diagnostics.hpp.

◆ x1edge_p1_

AthenaArray<Real> Diagnostics::x1edge_p1_
protected

Definition at line 58 of file diagnostics.hpp.

◆ x2edge_

AthenaArray<Real> Diagnostics::x2edge_
protected

Definition at line 58 of file diagnostics.hpp.

◆ x2edge_p1_

AthenaArray<Real> Diagnostics::x2edge_p1_
protected

Definition at line 58 of file diagnostics.hpp.

◆ x3edge_

AthenaArray<Real> Diagnostics::x3edge_
protected

Definition at line 58 of file diagnostics.hpp.

◆ x3edge_p1_

AthenaArray<Real> Diagnostics::x3edge_p1_
protected

Definition at line 59 of file diagnostics.hpp.

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