Use Component & Physics syntax

include/base/EnclosureAdvectionReaction1D.h

@@ -0,0 +1,22 @@
+/********************************************************/
+/* DO NOT MODIFY THIS HEADER */
+/* TMAP8: Tritium Migration Analysis Program, Version 8 */
+/* */
+/* Copyright 2021 Battelle Energy Alliance, LLC */
+/* ALL RIGHTS RESERVED */
+/********************************************************/
+
+#include "FlowModelSinglePhase.h"
+
+class EnclosureAdvectionReaction1D : public FlowModelSinglePhase
+{
+public:
+ EnclosureAdvectionReaction1D(const InputParameters & params);
+
+ virtual void init() override;
+ virtual void addVariables() override;
+ virtual void addInitialConditions() override;
+ virtual void addMooseObjects() override;
+
+ static InputParameters validParams();
+};

include/base/TMAPUtils.h

@@ -0,0 +1,15 @@
+/********************************************************/
+/* DO NOT MODIFY THIS HEADER */
+/* TMAP8: Tritium Migration Analysis Program, Version 8 */
+/* */
+/* Copyright 2021 Battelle Energy Alliance, LLC */
+/* ALL RIGHTS RESERVED */
+/********************************************************/
+
+class InputParameters;
+
+namespace TMAP
+{
+InputParameters structureCommonParams();
+InputParameters enclosureCommonParams();
+}

include/bcs/EquilibriumBC.h

@@ -33,8 +33,11 @@ class EquilibriumBC : public ADNodalBC
  const bool _enclosure_var_bool_scalar;
  const ADVariableValue & _enclosure_var;
 
- /// The temperature (K)
- const ADVariableValue & _T;
+ /// The temperature as a variable (K)
+ const ADVariableValue * const _T;
+
+ /// The temperature as a function (K)
+ const Function * _T_function;
 
  /// The number of atoms that compose our arbitrary unit for quantity
  const Real _var_scaling_factor;

include/components/Enclosure0D.h

@@ -0,0 +1,65 @@
+/********************************************************/
+/* DO NOT MODIFY THIS HEADER */
+/* TMAP8: Tritium Migration Analysis Program, Version 8 */
+/* */
+/* Copyright 2021 Battelle Energy Alliance, LLC */
+/* ALL RIGHTS RESERVED */
+/********************************************************/
+
+#pragma once
+
+#include "ActionComponent.h"
+#include "PhysicsComponentBase.h"
+
+/**
+ * Enclosure component which can trap a species, e.g. Tritium
+ */
+class Enclosure0D : public virtual ActionComponent, public PhysicsComponentBase
+{
+public:
+ Enclosure0D(const InputParameters & params);
+
+ static InputParameters validParams();
+
+ /// Return the species living on this component
+ const std::vector<NonlinearVariableName> & species() const { return _species; }
+ /// Return the scaling factors to use for these species
+ const std::vector<Real> & scalingFactors() const { return _scaling_factors; }
+ /// Return the initial conditions to use for these species
+ const std::vector<Real> & ics() const { return _ics; }
+ /// Return the temperature of this enclosure
+ Real temperature() const { return _temperature; }
+ /// Returns the scaled volume of the enclosure
+ virtual Real volume() const override { return _volume; }
+ /// Returns the scaled outer boundary surface area
+ virtual Real outerSurfaceArea() const override { return _surface_area; }
+ /// Returns the boundary of the enclosure, connecting with the structure
+ virtual const std::vector<BoundaryName> & outerSurfaceBoundaries() const override
+ {
+ _console << Moose::stringify(_outer_boundaries);
+ return _outer_boundaries;
+ }
+ /// Get the connected structure name
+ ComponentName connectedStructure() const
+ {
+ return getParam<ComponentName>("connected_structure");
+ }
+
+protected:
+ virtual void initComponentPhysics() override;
+
+ /// Vector of the names of the species to track
+ std::vector<NonlinearVariableName> _species;
+ /// Scaling factors for the nonlinear species equations
+ std::vector<Real> _scaling_factors;
+ /// Initial conditions for each species
+ std::vector<Real> _ics;
+ /// Temperature of the enclosure
+ const Real _temperature;
+ /// Outer surface area of the enclosure
+ const Real _surface_area;
+ /// Volume of the enclosure
+ const Real _volume;
+ /// Surface connecting the enclosure with the structure
+ const std::vector<BoundaryName> _outer_boundaries;
+};

include/components/Structure1D.h

@@ -0,0 +1,38 @@
+/********************************************************/
+/* DO NOT MODIFY THIS HEADER */
+/* TMAP8: Tritium Migration Analysis Program, Version 8 */
+/* */
+/* Copyright 2021 Battelle Energy Alliance, LLC */
+/* ALL RIGHTS RESERVED */
+/********************************************************/
+
+#pragma once
+
+#include "ActionComponent.h"
+#include "PhysicsComponentBase.h"
+
+/**
+ * A 1D structure on which a species can diffuse
+ */
+class Structure1D : public virtual ActionComponent, public PhysicsComponentBase
+{
+public:
+ Structure1D(const InputParameters & params);
+
+ static InputParameters validParams();
+
+ virtual void addMeshGenerators() override;
+
+ /// Return the species diffused on this structures
+ const std::vector<NonlinearVariableName> & species() const { return _species; }
+ /// Return the initial conditions fhe species concentrations on this structure
+ const std::vector<Real> & ics() { return _ics; };
+
+protected:
+ /// Names of the variables for the species
+ const std::vector<NonlinearVariableName> _species;
+ /// Initial values for the variables
+ const std::vector<Real> _ics;
+ /// Unit for the mesh
+ const Real _length_unit;
+};

include/physics/FieldTrappingPhysics.h

@@ -0,0 +1,58 @@
+//* This file is part of the MOOSE framework
+//* https://www.mooseframework.org
+//*
+//* All rights reserved, see COPYRIGHT for full restrictions
+//* https://github.com/idaholab/moose/blob/master/COPYRIGHT
+//*
+//* Licensed under LGPL 2.1, please see LICENSE for details
+//* https://www.gnu.org/licenses/lgpl-2.1.html
+
+#pragma once
+
+#include "SpeciesTrappingPhysicsBase.h"
+
+class ActionComponent;
+
+/**
+ * Creates all the objects needed to solve for the concentration of a scalar in traps distributed
+ * over a mesh.
+ */
+class FieldTrappingPhysics : public SpeciesTrappingPhysicsBase
+{
+public:
+ static InputParameters validParams();
+
+ FieldTrappingPhysics(const InputParameters & parameters);
+
+ void addComponent(const ActionComponent & component) override;
+
+protected:
+ /// Return the name of the species variable
+ /// @param c_i index of the component
+ /// @param s_j index of the species
+ VariableName getSpeciesVariableName(unsigned int c_i, unsigned int s_j) const;
+
+ /// The mobile species of interest
+ std::vector<std::vector<VariableName>> _mobile_species_names;
+
+ // Properties on each component
+ /// Trapping rate coefficient for each component (outer indexing) and species (inner)
+ std::vector<std::vector<Real>> _alpha_ts;
+ /// Atomic number density of the host material
+ std::vector<Real> _Ns;
+ /// Fraction of host sites that contribute to trapping
+ std::vector<Real> _Ct0s;
+ /// Estimate for the ratio of the concentration magnitude of trapped species to free species for each component
+ std::vector<Real> _trap_per_frees;
+ ///
+ std::vector<std::vector<Real>> _alpha_rs;
+ std::vector<std::vector<Real>> _trapping_energies;
+
+ /// Whether to define a single variable for each species for all components, or a different one for each component
+ const bool _single_variable_set;
+
+private:
+ virtual void addNonlinearVariables() override;
+ virtual void addInitialConditions() override;
+ virtual void addFEKernels() override;
+};

include/physics/MultiSpeciesMigrationCG.h

@@ -0,0 +1,27 @@
+//* This file is part of the MOOSE framework
+//* https://www.mooseframework.org
+//*
+//* All rights reserved, see COPYRIGHT for full restrictions
+//* https://github.com/idaholab/moose/blob/master/COPYRIGHT
+//*
+//* Licensed under LGPL 2.1, please see LICENSE for details
+//* https://www.gnu.org/licenses/lgpl-2.1.html
+
+#pragma once
+
+#include "MultiSpeciesDiffusionCG.h"
+
+/**
+ * Creates all the objects needed to solve diffusion equations for multiple species with a
+ * continuous Galerkin finite element discretization
+ */
+class MultiSpeciesMigrationCG : public MultiSpeciesDiffusionCG
+{
+public:
+ static InputParameters validParams();
+
+ MultiSpeciesMigrationCG(const InputParameters & parameters);
+
+private:
+ virtual void addFEKernels() override;
+};

include/physics/PointTrappingPhysics.h

@@ -0,0 +1,58 @@
+//* This file is part of the MOOSE framework
+//* https://www.mooseframework.org
+//*
+//* All rights reserved, see COPYRIGHT for full restrictions
+//* https://github.com/idaholab/moose/blob/master/COPYRIGHT
+//*
+//* Licensed under LGPL 2.1, please see LICENSE for details
+//* https://www.gnu.org/licenses/lgpl-2.1.html
+
+#pragma once
+
+#include "SpeciesTrappingPhysicsBase.h"
+
+// Forward declarations
+class ActionComponent;
+
+/**
+ * Creates all the objects needed to solve for the concentration of a scalar in 0D trap(s).
+ */
+class PointTrappingPhysics : public SpeciesTrappingPhysicsBase
+{
+public:
+ static InputParameters validParams();
+
+ PointTrappingPhysics(const InputParameters & parameters);
+
+ void addComponent(const ActionComponent & component) override;
+
+protected:
+ /// Equilibrium constants / solubilities?
+ std::vector<std::vector<Real>> _species_Ks;
+
+ /// Scaling factor for lengths
+ const Real _length_unit;
+ /// Scaling factor for pressures
+ const Real _pressure_unit;
+
+private:
+ virtual void addNonlinearVariables() override;
+ virtual void addInitialConditions() override;
+ virtual void addScalarKernels() override;
+ virtual void addFEBCs() override;
+
+ /// Returns an error message if more than one boundary exists on the component
+ void checkSingleBoundary(const std::vector<BoundaryName> & boundaries,
+ const ComponentName & comp) const;
+
+ /// Get the variable name for the structure connected to the component
+ /// @param c_i index of the component
+ /// @param s_j index of the species
+ const VariableName & getConnectedStructureVariableName(unsigned int c_i, unsigned int s_j);
+ /// Get the boundary name for the surface connecting the structure to the component
+ /// @param c_i index of the component
+ const BoundaryName & getConnectedStructureBoundary(unsigned int c_i);
+ /// Get the Physics active on the structure connected to the component
+ /// @param c_i index of the component
+ const std::vector<PhysicsBase *> getConnectedStructurePhysics(unsigned int c_i);
+};