www.mooseframework.org
include
vectorpostprocessors
LineFunctionSampler.h
Go to the documentation of this file.
1
//* This file is part of the MOOSE framework
2
//* https://www.mooseframework.org
3
//*
4
//* All rights reserved, see COPYRIGHT for full restrictions
5
//* https://github.com/idaholab/moose/blob/master/COPYRIGHT
6
//*
7
//* Licensed under LGPL 2.1, please see LICENSE for details
8
//* https://www.gnu.org/licenses/lgpl-2.1.html
9
10
#pragma once
11
12
#include "
GeneralVectorPostprocessor.h
"
13
#include "
SamplerBase.h
"
14
15
// Forward Declarations
16
class
Function
;
17
class
LineFunctionSampler
:
public
GeneralVectorPostprocessor
,
protected
SamplerBase
18
{
19
public
:
20
static
InputParameters
validParams
();
21
22
LineFunctionSampler
(
const
InputParameters
&
parameters
);
23
24
virtual
void
initialize
()
override
;
25
virtual
void
execute
()
override
;
26
virtual
void
finalize
()
override
;
27
28
protected
:
30
Point
_start_point
;
31
33
Point
_end_point
;
34
36
unsigned
int
_num_points
;
37
39
const
std::vector<FunctionName> &
_function_names
;
40
42
unsigned
int
_num_funcs
;
43
45
std::vector<const Function *>
_functions
;
46
48
std::vector<Real>
_values
;
49
51
std::vector<Point>
_points
;
52
54
std::vector<Real>
_ids
;
55
};
SamplerBase
Base class for VectorPostprocessors that need to do "sampling" of values in the domain.
Definition:
SamplerBase.h:36
Function
Base class for function objects.
Definition:
Function.h:37
LineFunctionSampler::_functions
std::vector< const Function * > _functions
Pointers to the Functions.
Definition:
LineFunctionSampler.h:45
LineFunctionSampler::_start_point
Point _start_point
Beginning of the line.
Definition:
LineFunctionSampler.h:30
LineFunctionSampler::LineFunctionSampler
LineFunctionSampler(const InputParameters ¶meters)
Definition:
LineFunctionSampler.C:37
GeneralVectorPostprocessor
This class is here to combine the VectorPostprocessor interface and the base class VectorPostprocesso...
Definition:
GeneralVectorPostprocessor.h:21
InputParameters
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system...
Definition:
InputParameters.h:63
GeneralVectorPostprocessor.h
LineFunctionSampler::finalize
virtual void finalize() override
Finalize.
Definition:
LineFunctionSampler.C:87
LineFunctionSampler::_points
std::vector< Point > _points
The points to evaluate at.
Definition:
LineFunctionSampler.h:51
LineFunctionSampler
Definition:
LineFunctionSampler.h:17
LineFunctionSampler::_end_point
Point _end_point
End of the line.
Definition:
LineFunctionSampler.h:33
LineFunctionSampler::execute
virtual void execute() override
Execute method.
Definition:
LineFunctionSampler.C:71
LineFunctionSampler::_num_funcs
unsigned int _num_funcs
Number of Functions we're sampling.
Definition:
LineFunctionSampler.h:42
MooseBaseParameterInterface::parameters
const InputParameters & parameters() const
Get the parameters of the object.
Definition:
MooseBaseParameterInterface.h:62
LineFunctionSampler::_ids
std::vector< Real > _ids
The ID to use for each point (yes, this is Real on purpose)
Definition:
LineFunctionSampler.h:54
LineFunctionSampler::_function_names
const std::vector< FunctionName > & _function_names
Names of the Functions.
Definition:
LineFunctionSampler.h:39
LineFunctionSampler::validParams
static InputParameters validParams()
Definition:
LineFunctionSampler.C:19
LineFunctionSampler::_num_points
unsigned int _num_points
Number of points along the line.
Definition:
LineFunctionSampler.h:36
LineFunctionSampler::initialize
virtual void initialize() override
Initialize the datastructures.
Definition:
LineFunctionSampler.C:65
LineFunctionSampler::_values
std::vector< Real > _values
So we don't have to create and destroy this vector over and over again.
Definition:
LineFunctionSampler.h:48
SamplerBase.h
Generated on Wed Mar 27 2024 17:44:39 for www.mooseframework.org by
1.8.14