https://mooseframework.inl.gov
IntegralPreservingFunctionIC.h
Go to the documentation of this file.
1 //* This file is part of the MOOSE framework
2 //* https://mooseframework.inl.gov
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 "FunctionIC.h"
13 
19 {
20 public:
22 
24 
25  virtual void initialSetup() override;
26 
30  Real magnitude() const { return _magnitude; }
31 
32 protected:
33  virtual Real value(const Point & p) override;
34 
36  const PostprocessorName & _pp_name;
37 
40 
42  const Real & _magnitude;
43 };
Defines an initial condition that forces the value to be a user specified function.
Definition: FunctionIC.h:17
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system...
Initial conditions specifying an initial condition as a general function while preserving a total int...
const Real & _magnitude
Magnitude of the initial condition upon integration.
IntegralPreservingFunctionIC(const InputParameters &parameters)
Real PostprocessorValue
various MOOSE typedefs
Definition: MooseTypes.h:202
const PostprocessorValue & _integral
Integral of the function.
const PostprocessorName & _pp_name
Name of postprocessor providing the integral of the function.
virtual void initialSetup() override
Gets called at the beginning of the simulation before this object is asked to do its job...
virtual Real value(const Point &p) override
The value of the variable at a point.
DIE A HORRIBLE DEATH HERE typedef LIBMESH_DEFAULT_SCALAR_TYPE Real
const InputParameters & parameters() const
Get the parameters of the object.