www.mooseframework.org
FXFluxBC.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 
10 #include "FXFluxBC.h"
11 #include "FunctionSeries.h"
12 
13 registerMooseObject("FunctionalExpansionToolsApp", FXFluxBC);
14 
15 template <>
16 InputParameters
18 {
19  InputParameters params = validParams<FunctionNeumannBC>();
20 
21  params.addClassDescription(
22  "Sets a flux boundary condition, evaluated using a FunctionSeries instance. This does not "
23  "fix the flux, but rather 'strongly encourages' flux agreement by penalizing the differences "
24  "through contributions to the residual.");
25 
26  return params;
27 }
28 
29 FXFluxBC::FXFluxBC(const InputParameters & parameters) : FunctionNeumannBC(parameters)
30 {
31  FunctionSeries & fe_basis =
32  FunctionSeries::checkAndConvertFunction(_func, getParam<std::string>("_moose_base"), name());
33 
34  fe_basis.useCache(true);
35 }
registerMooseObject
registerMooseObject("FunctionalExpansionToolsApp", FXFluxBC)
FXFluxBC.h
validParams< FXFluxBC >
InputParameters validParams< FXFluxBC >()
Definition: FXFluxBC.C:17
FunctionSeries
This class uses implementations of CompositeSeriesBasisInterface to generate a function based on conv...
Definition: FunctionSeries.h:25
FXFluxBC::FXFluxBC
FXFluxBC(const InputParameters &parameters)
Definition: FXFluxBC.C:29
name
const std::string name
Definition: Setup.h:21
MemoizedFunctionInterface::useCache
void useCache(bool use)
Enable/disable the cache.
Definition: MemoizedFunctionInterface.C:75
FXFluxBC
Defines an FX-based BC that strongly encourages the gradients to match.
Definition: FXFluxBC.h:22
FunctionSeries::checkAndConvertFunction
static FunctionSeries & checkAndConvertFunction(const Function &function, const std::string &typeName, const std::string &objectName)
Static function to cast a Function to SeriesFunction.
Definition: FunctionSeries.C:175
FunctionSeries.h