www.mooseframework.org
FXBoundaryFluxUserObject.C
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 
11 
12 registerMooseObject("FunctionalExpansionToolsApp", FXBoundaryFluxUserObject);
13 
16 {
18 
19  params.addClassDescription("Generates an Functional Expansion representation for a boundary flux "
20  "condition using a 'FunctionSeries'-type Function");
21 
22  params.addRequiredParam<std::string>("diffusivity",
23  "The name of the material diffusivity "
24  "property, or raw value, that will be used "
25  "in the flux computation.");
26 
27  return params;
28 }
29 
31  : FXBoundaryBaseUserObject(parameters),
32  _diffusivity_name(parameters.get<std::string>("diffusivity")),
33  _diffusivity(getMaterialProperty<Real>(_diffusivity_name))
34 {
35 }
36 
37 Real
39 {
40  return -_diffusivity[_qp] * _grad_u[_qp] * _normals[_qp];
41 }
This boundary FX evaluator calculates the flux.
static InputParameters validParams()
void addRequiredParam(const std::string &name, const std::string &doc_string)
This class provides the base for generating a functional expansion on a boundary by inheriting from F...
registerMooseObject("FunctionalExpansionToolsApp", FXBoundaryFluxUserObject)
static InputParameters validParams()
virtual Real computeQpIntegral() final
DIE A HORRIBLE DEATH HERE typedef LIBMESH_DEFAULT_SCALAR_TYPE Real
const MaterialProperty< Real > & _diffusivity
Value of the diffusivity.
const MooseArray< Point > & _normals
const VariableGradient & _grad_u
void addClassDescription(const std::string &doc_string)
const Elem & get(const ElemType type_in)
FXBoundaryFluxUserObject(const InputParameters &parameters)