doxygen/moose/ReporterPointSource_8h_source.html

//* This file is part of the MOOSE framework

//* https://mooseframework.inl.gov

//*

//* All rights reserved, see COPYRIGHT for full restrictions

//* https://github.com/idaholab/moose/blob/master/COPYRIGHT

//*

//* Licensed under LGPL 2.1, please see LICENSE for details

//* https://www.gnu.org/licenses/lgpl-2.1.html


#pragma once


// Moose Includes

#include "DiracKernel.h"

#include "ReporterInterface.h"


class ReporterPointSource : public DiracKernel, public ReporterInterface

{

public:

  static InputParameters validParams();

  ReporterPointSource(const InputParameters & parameters);

  virtual void addPoints() override;


protected:

  virtual Real computeQpResidual() override;

  void errorCheck(const std::string & input_name, std::size_t reporterSize);


  const bool _read_in_points;

  const std::vector<Real> & _values;

  std::vector<Real> _ones_vec;

  std::vector<Real> _zeros_vec;

  std::vector<Point> _zeros_pts;

  const std::vector<Real> & _coordx;

  const std::vector<Real> & _coordy;

  const std::vector<Real> & _coordz;

  const std::vector<Point> & _point;

  const std::vector<Real> & _weight;

};


DiracKernel.h

ReporterInterface.h

DiracKernelTempl
A DiracKernel is used when you need to add contributions to the residual by means of multiplying some...
Definition DiracKernel.h:33

InputParameters
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system.
Definition InputParameters.h:68

MooseBase::parameters
const InputParameters & parameters() const
Get the parameters of the object.
Definition MooseBase.h:131

ReporterInterface
Interface to allow object to consume Reporter values.
Definition ReporterInterface.h:23

ReporterPointSource
A ReporterPointSource DiracKernel is used to create variable valued point sources.
Definition ReporterPointSource.h:22

ReporterPointSource::computeQpResidual
virtual Real computeQpResidual() override
This is the virtual that derived classes should override for computing the residual.
Definition ReporterPointSource.C:111

ReporterPointSource::addPoints
virtual void addPoints() override
This is where the DiracKernel should call addPoint() for each point it needs to have a value distribu...
Definition ReporterPointSource.C:76

ReporterPointSource::_point
const std::vector< Point > & _point
xyz point
Definition ReporterPointSource.h:47

ReporterPointSource::_coordx
const std::vector< Real > & _coordx
x coordinate
Definition ReporterPointSource.h:41

ReporterPointSource::validParams
static InputParameters validParams()
Definition ReporterPointSource.C:16

ReporterPointSource::_ones_vec
std::vector< Real > _ones_vec
convenience vectors (these are not const because reporters can change their size)
Definition ReporterPointSource.h:37

ReporterPointSource::_coordz
const std::vector< Real > & _coordz
z coordinate
Definition ReporterPointSource.h:45

ReporterPointSource::_values
const std::vector< Real > & _values
values at each xyz coordinate
Definition ReporterPointSource.h:35

ReporterPointSource::errorCheck
void errorCheck(const std::string &input_name, std::size_t reporterSize)
Definition ReporterPointSource.C:118

ReporterPointSource::_coordy
const std::vector< Real > & _coordy
y coordinate
Definition ReporterPointSource.h:43

ReporterPointSource::_read_in_points
const bool _read_in_points
bool if data format read in is points
Definition ReporterPointSource.h:33

ReporterPointSource::_weight
const std::vector< Real > & _weight
weights to scale value by
Definition ReporterPointSource.h:49

ReporterPointSource::_zeros_pts
std::vector< Point > _zeros_pts
Definition ReporterPointSource.h:39

ReporterPointSource::_zeros_vec
std::vector< Real > _zeros_vec
Definition ReporterPointSource.h:38