LCOV - code coverage report
Current view: top level - include/vectorpostprocessors - StochasticResults.h (source / functions) Hit Total Coverage
Test: stochastic_tools Test Coverage Lines: 3 3 100.0 %
Date: 2017-11-21 14:52:30 Functions: 4 4 100.0 %
Legend: Lines: hit not hit

          Line data    Source code
       1             : /****************************************************************/
       2             : /* MOOSE - Multiphysics Object Oriented Simulation Environment  */
       3             : /*                                                              */
       4             : /*          All contents are licensed under LGPL V2.1           */
       5             : /*             See LICENSE for full restrictions                */
       6             : /****************************************************************/
       7             : 
       8             : #ifndef STOCHASTICRESULTS_H
       9             : #define STOCHASTICRESULTS_H
      10             : 
      11             : // MOOSE includes
      12             : #include "GeneralVectorPostprocessor.h"
      13             : #include "SamplerInterface.h"
      14             : 
      15             : class StochasticResults;
      16             : 
      17             : template <>
      18             : InputParameters validParams<StochasticResults>();
      19             : 
      20             : /**
      21             :  * A tool for output Sampler data.
      22             :  */
      23           3 : class StochasticResults : public GeneralVectorPostprocessor, SamplerInterface
      24             : {
      25             : public:
      26             :   StochasticResults(const InputParameters & parameters);
      27             :   void virtual initialize() override;
      28           5 :   void virtual finalize() override {}
      29           5 :   void virtual execute() override {}
      30             : 
      31             :   /**
      32             :    * Initialize storage based on the Sampler returned by the SamplerMultiApp.
      33             :    * @param sampler The Sampler associated with the MultiApp that this VPP is working with.
      34             :    *
      35             :    * This method is called by the SamplerPostprocessorTransfer.
      36             :    */
      37             :   void init(Sampler & _sampler);
      38             : 
      39             :   /**
      40             :    * Return the VectorPostprocessorValue for a given Sampler group index.
      41             :    * @param group Index related to the index of the DenseMatrix returned by Sampler::getSamples()
      42             :    * @return A reference to the storage location for the PP data from the sub-applications.
      43             :    */
      44             :   VectorPostprocessorValue & getVectorPostprocessorValueByGroup(unsigned int group);
      45             : 
      46             :   /**
      47             :    * Get the sample vectors
      48             :    * @return A const pointer to the vector of sample vectors
      49             :    */
      50             :   const std::vector<VectorPostprocessorValue *> & getSampleVectors() const
      51             :   {
      52             :     return _sample_vectors;
      53             :   }
      54             : 
      55             : protected:
      56             :   /// Storage for declared vectors
      57             :   std::vector<VectorPostprocessorValue *> _sample_vectors;
      58             : 
      59             :   /// The sampler to extract data
      60             :   Sampler * _sampler = nullptr;
      61             : };
      62             : 
      63             : #endif

Generated by: LCOV version 1.11