ABLATE Source Documentation  0.12.34
ablate::monitors::Probes Class Reference

#include <probes.hpp>

+ Inheritance diagram for ablate::monitors::Probes:

Classes

class  ProbeRecorder
 

Public Member Functions

 Probes (const std::shared_ptr< ablate::monitors::probes::ProbeInitializer > &, std::vector< std::string > variableNames, const std::shared_ptr< io::interval::Interval > &interval={}, const int bufferSize=0)
 
void Register (std::shared_ptr< solver::Solver > solver) override
 
PetscMonitorFunction GetPetscFunction () override
 
- Public Member Functions inherited from ablate::monitors::Monitor
virtual void * GetContext ()
 

Static Public Member Functions

static PetscErrorCode UpdateProbes (TS ts, PetscInt step, PetscReal crtime, Vec u, void *ctx)
 

Public Attributes

const std::shared_ptr< ablate::monitors::probes::ProbeInitializerinitializer
 Original list of all requested probe locations by name.
 
const std::vector< std::string > variableNames
 List of variables to output.
 
const std::shared_ptr< io::interval::Intervalinterval
 The sampling interval.
 
const int bufferSize
 output bufferSize
 
std::vector< probes::ProbelocalProbes
 list of local probes on this rank
 
std::vector< domain::Fieldfields
 list of fields to interpolate
 
std::vector< int > fieldOffset
 store the offset for the field in the output (needed for multiple components)
 
std::vector< DMInterpolationInfo > interpolants
 list of petsc intepolants
 
std::vector< ProbeRecorderrecorders
 list of probe recorders that goe
 

Additional Inherited Members

- Protected Member Functions inherited from ablate::monitors::Monitor
std::shared_ptr< solver::SolverGetSolver ()
 

Detailed Description

Used to monitor field variables at a specified list of locations

Constructor & Destructor Documentation

◆ Probes()

ablate::monitors::Probes::Probes ( const std::shared_ptr< ablate::monitors::probes::ProbeInitializer > &  initializer,
std::vector< std::string >  variableNames,
const std::shared_ptr< io::interval::Interval > &  interval = {},
const int  bufferSize = 0 
)

Probes monitor

Parameters
probeLocationsa vector of names and probe locations
variablesa list of output variables
bufferSizethe buffer size between writes
intervalthe sampling interval

Member Function Documentation

◆ GetPetscFunction()

PetscMonitorFunction ablate::monitors::Probes::GetPetscFunction ( )
inlineoverridevirtual

Returns the petsc function used to update the monitor.

Returns

Reimplemented from ablate::monitors::Monitor.

◆ Register()

void ablate::monitors::Probes::Register ( std::shared_ptr< solver::Solver solver)
overridevirtual

Overrides the base register and used to determine which nodes lives on each rank

Parameters
solver

Reimplemented from ablate::monitors::Monitor.


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