Finite Volume Solver  prototype
A framework to build finite volume solvers for the AG Klein at the Freie Universität Berlin.
Public Member Functions | Private Attributes | List of all members
fub::amrex::DebugSnapshotProxy Class Reference

This class is a possibly empty handle to a existing DebugSnapshotProxy. More...

#include <DebugOutput.hpp>

Public Member Functions

 DebugSnapshotProxy ()=default
 Initializes an empty proxy snapshot. More...
 
 DebugSnapshotProxy (DebugSnapshot &snapshot)
 Initializes a proxy snapshot for a real snapshot. More...
 
 operator bool () const noexcept
 Returns true if this object is valid. More...
 
void SaveData (const ::amrex::MultiFab &mf, const std::string &name, const ::amrex::Geometry &geom, ::amrex::SrcComp component=::amrex::SrcComp(0))
 Saves a current hierarchy state with given component names. More...
 
void SaveData (const ::amrex::MultiFab &mf, const DebugSnapshot::ComponentNames &names, const ::amrex::Geometry &geom, ::amrex::SrcComp first_component=::amrex::SrcComp(0))
 Saves a current hierarchy state with given component names. More...
 
void SaveData (const ::amrex::Vector< const ::amrex::MultiFab * > &hierarchy, const std::string &name, const ::amrex::Vector< const ::amrex::Geometry * > &geomhier, ::amrex::SrcComp component=::amrex::SrcComp(0))
 Saves a current hierarchy state with given component names. More...
 
void SaveData (const ::amrex::Vector<::amrex::MultiFab > &hierarchy, const std::string &name, const ::amrex::Vector<::amrex::Geometry > &geomhier, ::amrex::SrcComp component=::amrex::SrcComp(0))
 Saves a current hierarchy state with given component names. More...
 
void SaveData (const ::amrex::Vector< const ::amrex::MultiFab * > &hierarchy, const DebugSnapshot::ComponentNames &names, const ::amrex::Vector< const ::amrex::Geometry * > &geomhier, ::amrex::SrcComp first_component=::amrex::SrcComp(0))
 Saves a current hierarchy state with given component names. More...
 
void SaveData (const ::amrex::Vector<::amrex::MultiFab > &hierarchy, const DebugSnapshot::ComponentNames &names, const ::amrex::Vector<::amrex::Geometry > &geomhier, ::amrex::SrcComp first_component=::amrex::SrcComp(0))
 Saves a current hierarchy state with given component names. More...
 

Private Attributes

DebugSnapshotsnapshot_
 Pointer to the real snapshot. More...
 

Detailed Description

This class is a possibly empty handle to a existing DebugSnapshotProxy.

DebugSnapshotProxy maybe in a valid or invalid

Constructor & Destructor Documentation

◆ DebugSnapshotProxy() [1/2]

fub::amrex::DebugSnapshotProxy::DebugSnapshotProxy ( )
default

Initializes an empty proxy snapshot.

◆ DebugSnapshotProxy() [2/2]

fub::amrex::DebugSnapshotProxy::DebugSnapshotProxy ( DebugSnapshot snapshot)
inline

Initializes a proxy snapshot for a real snapshot.

Member Function Documentation

◆ operator bool()

fub::amrex::DebugSnapshotProxy::operator bool ( ) const
inlineexplicitnoexcept

Returns true if this object is valid.

◆ SaveData() [1/6]

void fub::amrex::DebugSnapshotProxy::SaveData ( const ::amrex::MultiFab &  mf,
const DebugSnapshot::ComponentNames names,
const ::amrex::Geometry geom,
::amrex::SrcComp  first_component = ::amrex::SrcComp(0) 
)

Saves a current hierarchy state with given component names.

The actual output will be handled by the DebugOutput class and will usually happen at a later time point.

◆ SaveData() [2/6]

void fub::amrex::DebugSnapshotProxy::SaveData ( const ::amrex::MultiFab &  mf,
const std::string &  name,
const ::amrex::Geometry geom,
::amrex::SrcComp  component = ::amrex::SrcComp(0) 
)

Saves a current hierarchy state with given component names.

The actual output will be handled by the DebugOutput class and will usually happen at a later time point.

◆ SaveData() [3/6]

void fub::amrex::DebugSnapshotProxy::SaveData ( const ::amrex::Vector< const ::amrex::MultiFab * > &  hierarchy,
const DebugSnapshot::ComponentNames names,
const ::amrex::Vector< const ::amrex::Geometry * > &  geomhier,
::amrex::SrcComp  first_component = ::amrex::SrcComp(0) 
)

Saves a current hierarchy state with given component names.

The actual output will be handled by the DebugOutput class and will usually happen at a later time point.

◆ SaveData() [4/6]

void fub::amrex::DebugSnapshotProxy::SaveData ( const ::amrex::Vector< const ::amrex::MultiFab * > &  hierarchy,
const std::string &  name,
const ::amrex::Vector< const ::amrex::Geometry * > &  geomhier,
::amrex::SrcComp  component = ::amrex::SrcComp(0) 
)

Saves a current hierarchy state with given component names.

The actual output will be handled by the DebugOutput class and will usually happen at a later time point.

◆ SaveData() [5/6]

void fub::amrex::DebugSnapshotProxy::SaveData ( const ::amrex::Vector<::amrex::MultiFab > &  hierarchy,
const DebugSnapshot::ComponentNames names,
const ::amrex::Vector<::amrex::Geometry > &  geomhier,
::amrex::SrcComp  first_component = ::amrex::SrcComp(0) 
)

Saves a current hierarchy state with given component names.

The actual output will be handled by the DebugOutput class and will usually happen at a later time point.

◆ SaveData() [6/6]

void fub::amrex::DebugSnapshotProxy::SaveData ( const ::amrex::Vector<::amrex::MultiFab > &  hierarchy,
const std::string &  name,
const ::amrex::Vector<::amrex::Geometry > &  geomhier,
::amrex::SrcComp  component = ::amrex::SrcComp(0) 
)

Saves a current hierarchy state with given component names.

The actual output will be handled by the DebugOutput class and will usually happen at a later time point.

Member Data Documentation

◆ snapshot_

DebugSnapshot* fub::amrex::DebugSnapshotProxy::snapshot_
private

Pointer to the real snapshot.


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