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 
14 template <>
15 InputParameters
17 {
18  InputParameters params = validParams<FXBoundaryBaseUserObject>();
19 
20  params.addClassDescription("Generates an Functional Expansion representation for a boundary flux "
21  "condition using a 'FunctionSeries'-type Function");
22 
23  params.addRequiredParam<std::string>("diffusivity",
24  "The name of the material diffusivity "
25  "property, or raw value, that will be used "
26  "in the flux computation.");
27 
28  return params;
29 }
30 
31 FXBoundaryFluxUserObject::FXBoundaryFluxUserObject(const InputParameters & parameters)
32  : FXBoundaryBaseUserObject(parameters),
33  _diffusivity_name(parameters.get<std::string>("diffusivity")),
34  _diffusivity(getMaterialProperty<Real>(_diffusivity_name))
35 {
36 }
37 
38 Real
40 {
41  return -_diffusivity[_qp] * _grad_u[_qp] * _normals[_qp];
42 }
FXBoundaryFluxUserObject.h
registerMooseObject
registerMooseObject("FunctionalExpansionToolsApp", FXBoundaryFluxUserObject)
validParams< FXBoundaryBaseUserObject >
InputParameters validParams< FXBoundaryBaseUserObject >()
Definition: FXBoundaryBaseUserObject.C:14
FXBoundaryFluxUserObject::FXBoundaryFluxUserObject
FXBoundaryFluxUserObject(const InputParameters &parameters)
Definition: FXBoundaryFluxUserObject.C:31
FXBoundaryBaseUserObject
This class provides the base for generating a functional expansion on a boundary by inheriting from F...
Definition: FXBoundaryBaseUserObject.h:26
FXBoundaryFluxUserObject::computeQpIntegral
virtual Real computeQpIntegral() final
Definition: FXBoundaryFluxUserObject.C:39
FXBoundaryFluxUserObject::_diffusivity
const MaterialProperty< Real > & _diffusivity
Value of the diffusivity.
Definition: FXBoundaryFluxUserObject.h:35
validParams< FXBoundaryFluxUserObject >
InputParameters validParams< FXBoundaryFluxUserObject >()
Definition: FXBoundaryFluxUserObject.C:16
FXBoundaryFluxUserObject
This boundary FX evaluator calculates the flux.
Definition: FXBoundaryFluxUserObject.h:22