www.mooseframework.org
FXValueBC.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 "FXValueBC.h"
11 #include "FunctionSeries.h"
12 
13 registerMooseObject("FunctionalExpansionToolsApp", FXValueBC);
14 
17 {
19 
20  params.addClassDescription(
21  "Imposes a fixed value boundary condition, evaluated using a FunctionSeries instance.");
22 
23  return params;
24 }
25 
26 FXValueBC::FXValueBC(const InputParameters & parameters) : FunctionDirichletBC(parameters)
27 {
28  FunctionSeries & fe_basis =
29  FunctionSeries::checkAndConvertFunction(_func, getParam<std::string>("_moose_base"), name());
30 
31  fe_basis.useCache(true);
32 }
static InputParameters validParams()
Definition: FXValueBC.C:16
Defines an FX-based boundary condition that forces the values to match.
Definition: FXValueBC.h:17
static InputParameters validParams()
virtual const std::string & name() const
This class uses implementations of CompositeSeriesBasisInterface to generate a function based on conv...
const Function & _func
static FunctionSeries & checkAndConvertFunction(const Function &function, const std::string &typeName, const std::string &objectName)
Static function to cast a Function to SeriesFunction.
void useCache(bool use)
Enable/disable the cache.
void addClassDescription(const std::string &doc_string)
FXValueBC(const InputParameters &parameters)
Definition: FXValueBC.C:26
registerMooseObject("FunctionalExpansionToolsApp", FXValueBC)