diff --git a/doc/content/source/bcs/OutflowRobinBC.md b/doc/content/source/bcs/OutflowRobinBC.md new file mode 100644 index 0000000..617a270 --- /dev/null +++ b/doc/content/source/bcs/OutflowRobinBC.md @@ -0,0 +1,23 @@ +# OutflowRobinBC + +!alert construction title=Undocumented Class +The OutflowRobinBC has not been documented. The content listed below should be used as a starting point for +documenting the class, which includes the typical automatic documentation associated with a +MooseObject; however, what is contained is ultimately determined by what is necessary to make the +documentation clear for users. + +!syntax description /BCs/OutflowRobinBC + +## Overview + +!! Replace these lines with information regarding the OutflowRobinBC object. + +## Example Input File Syntax + +!! Describe and include an example of how to use the OutflowRobinBC object. + +!syntax parameters /BCs/OutflowRobinBC + +!syntax inputs /BCs/OutflowRobinBC + +!syntax children /BCs/OutflowRobinBC diff --git a/doc/content/source/bcs/RobinBC.md b/doc/content/source/bcs/RobinBC.md deleted file mode 100644 index d4854a2..0000000 --- a/doc/content/source/bcs/RobinBC.md +++ /dev/null @@ -1,23 +0,0 @@ -# RobinBC - -!alert construction title=Undocumented Class -The RobinBC has not been documented. The content listed below should be used as a starting point for -documenting the class, which includes the typical automatic documentation associated with a -MooseObject; however, what is contained is ultimately determined by what is necessary to make the -documentation clear for users. - -!syntax description /BCs/RobinBC - -## Overview - -!! Replace these lines with information regarding the RobinBC object. - -## Example Input File Syntax - -!! Describe and include an example of how to use the RobinBC object. - -!syntax parameters /BCs/RobinBC - -!syntax inputs /BCs/RobinBC - -!syntax children /BCs/RobinBC diff --git a/include/bcs/RobinBC.h b/include/bcs/OutflowRobinBC.h similarity index 69% rename from include/bcs/RobinBC.h rename to include/bcs/OutflowRobinBC.h index 5686822..bd5a996 100644 --- a/include/bcs/RobinBC.h +++ b/include/bcs/OutflowRobinBC.h @@ -2,10 +2,10 @@ #include "IntegratedBC.h" -class RobinBC : public IntegratedBC +class OutflowRobinBC : public IntegratedBC { public: - RobinBC(const InputParameters & parameters); + OutflowRobinBC(const InputParameters & parameters); static InputParameters validParams(); diff --git a/src/bcs/RobinBC.C b/src/bcs/OutflowRobinBC.C similarity index 66% rename from src/bcs/RobinBC.C rename to src/bcs/OutflowRobinBC.C index 704e11f..09b7f12 100644 --- a/src/bcs/RobinBC.C +++ b/src/bcs/OutflowRobinBC.C @@ -1,30 +1,30 @@ -#include "RobinBC.h" +#include "OutflowRobinBC.h" -registerMooseObject("SquirrelApp", RobinBC); +registerMooseObject("SquirrelApp", OutflowRobinBC); InputParameters -RobinBC::validParams() +OutflowRobinBC::validParams() { InputParameters params = IntegratedBC::validParams(); params.addParam("velocity", 1, "The 1D velocity."); return params; } -RobinBC::RobinBC(const InputParameters & parameters) +OutflowRobinBC::OutflowRobinBC(const InputParameters & parameters) : IntegratedBC(parameters), _velocity(getParam("velocity")) { } Real -RobinBC::computeQpResidual() +OutflowRobinBC::computeQpResidual() { return _test[_i][_qp] * (1. + _velocity) * _u[_qp]; // return _test[_i][_qp] * -2. * _grad_u[_qp] * _normals[_qp]; } Real -RobinBC::computeQpJacobian() +OutflowRobinBC::computeQpJacobian() { return _test[_i][_qp] * (1. + _velocity) * _phi[_j][_qp]; // return _test[_i][_qp] * -2. * _grad_phi[_j][_qp] * _normals[_qp]; diff --git a/tests/bcs/robin/gold/faster_flow_out.e b/tests/bcs/outflow_robin/gold/faster_flow_out.e similarity index 100% rename from tests/bcs/robin/gold/faster_flow_out.e rename to tests/bcs/outflow_robin/gold/faster_flow_out.e diff --git a/tests/bcs/robin/gold/robin_out.e b/tests/bcs/outflow_robin/gold/robin_out.e similarity index 100% rename from tests/bcs/robin/gold/robin_out.e rename to tests/bcs/outflow_robin/gold/robin_out.e diff --git a/tests/bcs/robin/robin.i b/tests/bcs/outflow_robin/robin.i similarity index 88% rename from tests/bcs/robin/robin.i rename to tests/bcs/outflow_robin/robin.i index c836a23..189e534 100644 --- a/tests/bcs/robin/robin.i +++ b/tests/bcs/outflow_robin/robin.i @@ -1,5 +1,5 @@ # Advection-diffusion of u down a channel with a Dirichlet inlet and an open -# outlet. The RobinBC lets u leave at a rate proportional to its local value, +# outlet. The OutflowRobinBC lets u leave at a rate proportional to its local value, # so the profile decays toward the outlet instead of staying flat. v = 1 @@ -39,7 +39,7 @@ v = 1 value = 1 [] [outlet] - type = RobinBC + type = OutflowRobinBC variable = u boundary = right velocity = ${v} diff --git a/tests/bcs/robin/tests b/tests/bcs/outflow_robin/tests similarity index 100% rename from tests/bcs/robin/tests rename to tests/bcs/outflow_robin/tests