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