From eba6a3ca1bbba8e0ff0e7eee1e6c503578d96289 Mon Sep 17 00:00:00 2001 From: Guillaume Giudicelli Date: Thu, 29 Jun 2023 16:54:11 -0600 Subject: [PATCH 1/4] Move solid properties to their own folder, refs #12284 --- modules/doc/config.yml | 1 + .../doc/content/modules/solid_properties/index.md | 6 +++--- .../ThermalCompositeSiCProperties.md | 0 .../ThermalFunctionSolidProperties.md | 0 .../ThermalGraphiteProperties.md | 0 .../ThermalMonolithicSiCProperties.md | 0 .../ThermalSS316Properties.md | 0 .../ThermalSolidProperties.md | 0 .../solid_properties_units.md | 0 .../{userobjects => solidproperties}/SolidProperties.h | 0 .../ThermalCompositeSiCProperties.h | 0 .../ThermalFunctionSolidProperties.h | 0 .../ThermalGraphiteProperties.h | 0 .../ThermalMonolithicSiCProperties.h | 0 .../ThermalSS316Properties.h | 0 .../ThermalSolidProperties.h | 0 .../src/{userobjects => solidproperties}/SolidProperties.C | 0 .../ThermalCompositeSiCProperties.C | 0 .../ThermalFunctionSolidProperties.C | 0 .../ThermalGraphiteProperties.C | 0 .../ThermalMonolithicSiCProperties.C | 0 .../ThermalSS316Properties.C | 0 .../ThermalSolidProperties.C | 0 .../composite_sic/gold/composite_sic_vpp_0000.csv | 0 .../{userobjects => solidproperties}/composite_sic/tests | 0 .../functional/gold/functional_vpp_0000.csv | 0 .../tests/{userobjects => solidproperties}/functional/tests | 0 .../graphite/gold/graphite_451_vpp_0000.csv | 0 .../tests/{userobjects => solidproperties}/graphite/tests | 0 .../monolithic_sic/gold/monolithic_sic_vpp_0000.csv | 0 .../{userobjects => solidproperties}/monolithic_sic/tests | 0 .../gold/stainless_steel_316_vpp_0000.csv | 0 .../stainless_steel_316/tests | 0 .../thermal_solid_properties.i | 0 34 files changed, 4 insertions(+), 3 deletions(-) rename modules/solid_properties/doc/content/source/{userobjects => solidproperties}/ThermalCompositeSiCProperties.md (100%) rename modules/solid_properties/doc/content/source/{userobjects => solidproperties}/ThermalFunctionSolidProperties.md (100%) rename modules/solid_properties/doc/content/source/{userobjects => solidproperties}/ThermalGraphiteProperties.md (100%) rename modules/solid_properties/doc/content/source/{userobjects => solidproperties}/ThermalMonolithicSiCProperties.md (100%) rename modules/solid_properties/doc/content/source/{userobjects => solidproperties}/ThermalSS316Properties.md (100%) rename modules/solid_properties/doc/content/source/{userobjects => solidproperties}/ThermalSolidProperties.md (100%) rename modules/solid_properties/doc/content/source/{userobjects => solidproperties}/solid_properties_units.md (100%) rename modules/solid_properties/include/{userobjects => solidproperties}/SolidProperties.h (100%) rename modules/solid_properties/include/{userobjects => solidproperties}/ThermalCompositeSiCProperties.h (100%) rename modules/solid_properties/include/{userobjects => solidproperties}/ThermalFunctionSolidProperties.h (100%) rename modules/solid_properties/include/{userobjects => solidproperties}/ThermalGraphiteProperties.h (100%) rename modules/solid_properties/include/{userobjects => solidproperties}/ThermalMonolithicSiCProperties.h (100%) rename modules/solid_properties/include/{userobjects => solidproperties}/ThermalSS316Properties.h (100%) rename modules/solid_properties/include/{userobjects => solidproperties}/ThermalSolidProperties.h (100%) rename modules/solid_properties/src/{userobjects => solidproperties}/SolidProperties.C (100%) rename modules/solid_properties/src/{userobjects => solidproperties}/ThermalCompositeSiCProperties.C (100%) rename modules/solid_properties/src/{userobjects => solidproperties}/ThermalFunctionSolidProperties.C (100%) rename modules/solid_properties/src/{userobjects => solidproperties}/ThermalGraphiteProperties.C (100%) rename modules/solid_properties/src/{userobjects => solidproperties}/ThermalMonolithicSiCProperties.C (100%) rename modules/solid_properties/src/{userobjects => solidproperties}/ThermalSS316Properties.C (100%) rename modules/solid_properties/src/{userobjects => solidproperties}/ThermalSolidProperties.C (100%) rename modules/solid_properties/test/tests/{userobjects => solidproperties}/composite_sic/gold/composite_sic_vpp_0000.csv (100%) rename modules/solid_properties/test/tests/{userobjects => solidproperties}/composite_sic/tests (100%) rename modules/solid_properties/test/tests/{userobjects => solidproperties}/functional/gold/functional_vpp_0000.csv (100%) rename modules/solid_properties/test/tests/{userobjects => solidproperties}/functional/tests (100%) rename modules/solid_properties/test/tests/{userobjects => solidproperties}/graphite/gold/graphite_451_vpp_0000.csv (100%) rename modules/solid_properties/test/tests/{userobjects => solidproperties}/graphite/tests (100%) rename modules/solid_properties/test/tests/{userobjects => solidproperties}/monolithic_sic/gold/monolithic_sic_vpp_0000.csv (100%) rename modules/solid_properties/test/tests/{userobjects => solidproperties}/monolithic_sic/tests (100%) rename modules/solid_properties/test/tests/{userobjects => solidproperties}/stainless_steel_316/gold/stainless_steel_316_vpp_0000.csv (100%) rename modules/solid_properties/test/tests/{userobjects => solidproperties}/stainless_steel_316/tests (100%) rename modules/solid_properties/test/tests/{userobjects => solidproperties}/thermal_solid_properties.i (100%) diff --git a/modules/doc/config.yml b/modules/doc/config.yml index 9c670c0a8a6c..45bc1379123a 100644 --- a/modules/doc/config.yml +++ b/modules/doc/config.yml @@ -137,6 +137,7 @@ Extensions: restart: application_usage/restart_recover.md samplers: syntax/Samplers/index.md scalarkernels: syntax/ScalarKernels/index.md + solidproperties: syntax/SolidProperties/index.md splits: syntax/Preconditioning/index.md surrogates: syntax/Surrogates/index.md systems: syntax/Systems/index.md diff --git a/modules/solid_properties/doc/content/modules/solid_properties/index.md b/modules/solid_properties/doc/content/modules/solid_properties/index.md index 252e10ba94a8..a352ddd2190c 100644 --- a/modules/solid_properties/doc/content/modules/solid_properties/index.md +++ b/modules/solid_properties/doc/content/modules/solid_properties/index.md @@ -27,7 +27,7 @@ the overall type of property. The overall design of this module is as follows: of dependent quantities (temperature, porosity, etc.). Different "categories" of solid properties are grouped together into different userobjects. For example, common solid properties used in thermal simulations (specific heat, thermal conductivity), - are provided by derived classes of the [ThermalSolidProperties](/userobjects/ThermalSolidProperties.md) + are provided by derived classes of the [ThermalSolidProperties](/solidproperties/ThermalSolidProperties.md) userobject. Mechanics properties (Youngs modulus, Poisson ratio), would be provided by a separate "family" of userobjects. 2. *Materials* call these userobject functions to compute the material properties at @@ -38,7 +38,7 @@ the overall type of property. The overall design of this module is as follows: ## Thermal properties Thermal properties (density, specific heat, and thermal conductivity) are computed by -userobjects inheriting from the [ThermalSolidProperties](/userobjects/ThermalSolidProperties.md) base class. This class +userobjects inheriting from the [ThermalSolidProperties](/solidproperties/ThermalSolidProperties.md) base class. This class defines functions to compute these properties as a function of temperature: - compute isobaric specific heat - `Real cp_from_T(const Real & T)` @@ -157,7 +157,7 @@ to the formulation and overriding the methods that describe the solid properties For example, suppose new thermal solid properties were desired for granite. The first step is to create a userobject named `ThermalGraniteProperties` by -inheriting from [ThermalSolidProperties](/userobjects/ThermalSolidProperties.md) and +inheriting from [ThermalSolidProperties](/solidproperties/ThermalSolidProperties.md) and overriding all methods that you would like to implement. The header file for your new userobject indicates all methods that will be defined. diff --git a/modules/solid_properties/doc/content/source/userobjects/ThermalCompositeSiCProperties.md b/modules/solid_properties/doc/content/source/solidproperties/ThermalCompositeSiCProperties.md similarity index 100% rename from modules/solid_properties/doc/content/source/userobjects/ThermalCompositeSiCProperties.md rename to modules/solid_properties/doc/content/source/solidproperties/ThermalCompositeSiCProperties.md diff --git a/modules/solid_properties/doc/content/source/userobjects/ThermalFunctionSolidProperties.md b/modules/solid_properties/doc/content/source/solidproperties/ThermalFunctionSolidProperties.md similarity index 100% rename from modules/solid_properties/doc/content/source/userobjects/ThermalFunctionSolidProperties.md rename to modules/solid_properties/doc/content/source/solidproperties/ThermalFunctionSolidProperties.md diff --git a/modules/solid_properties/doc/content/source/userobjects/ThermalGraphiteProperties.md b/modules/solid_properties/doc/content/source/solidproperties/ThermalGraphiteProperties.md similarity index 100% rename from modules/solid_properties/doc/content/source/userobjects/ThermalGraphiteProperties.md rename to modules/solid_properties/doc/content/source/solidproperties/ThermalGraphiteProperties.md diff --git a/modules/solid_properties/doc/content/source/userobjects/ThermalMonolithicSiCProperties.md b/modules/solid_properties/doc/content/source/solidproperties/ThermalMonolithicSiCProperties.md similarity index 100% rename from modules/solid_properties/doc/content/source/userobjects/ThermalMonolithicSiCProperties.md rename to modules/solid_properties/doc/content/source/solidproperties/ThermalMonolithicSiCProperties.md diff --git a/modules/solid_properties/doc/content/source/userobjects/ThermalSS316Properties.md b/modules/solid_properties/doc/content/source/solidproperties/ThermalSS316Properties.md similarity index 100% rename from modules/solid_properties/doc/content/source/userobjects/ThermalSS316Properties.md rename to modules/solid_properties/doc/content/source/solidproperties/ThermalSS316Properties.md diff --git a/modules/solid_properties/doc/content/source/userobjects/ThermalSolidProperties.md b/modules/solid_properties/doc/content/source/solidproperties/ThermalSolidProperties.md similarity index 100% rename from modules/solid_properties/doc/content/source/userobjects/ThermalSolidProperties.md rename to modules/solid_properties/doc/content/source/solidproperties/ThermalSolidProperties.md diff --git a/modules/solid_properties/doc/content/source/userobjects/solid_properties_units.md b/modules/solid_properties/doc/content/source/solidproperties/solid_properties_units.md similarity index 100% rename from modules/solid_properties/doc/content/source/userobjects/solid_properties_units.md rename to modules/solid_properties/doc/content/source/solidproperties/solid_properties_units.md diff --git a/modules/solid_properties/include/userobjects/SolidProperties.h b/modules/solid_properties/include/solidproperties/SolidProperties.h similarity index 100% rename from modules/solid_properties/include/userobjects/SolidProperties.h rename to modules/solid_properties/include/solidproperties/SolidProperties.h diff --git a/modules/solid_properties/include/userobjects/ThermalCompositeSiCProperties.h b/modules/solid_properties/include/solidproperties/ThermalCompositeSiCProperties.h similarity index 100% rename from modules/solid_properties/include/userobjects/ThermalCompositeSiCProperties.h rename to modules/solid_properties/include/solidproperties/ThermalCompositeSiCProperties.h diff --git a/modules/solid_properties/include/userobjects/ThermalFunctionSolidProperties.h b/modules/solid_properties/include/solidproperties/ThermalFunctionSolidProperties.h similarity index 100% rename from modules/solid_properties/include/userobjects/ThermalFunctionSolidProperties.h rename to modules/solid_properties/include/solidproperties/ThermalFunctionSolidProperties.h diff --git a/modules/solid_properties/include/userobjects/ThermalGraphiteProperties.h b/modules/solid_properties/include/solidproperties/ThermalGraphiteProperties.h similarity index 100% rename from modules/solid_properties/include/userobjects/ThermalGraphiteProperties.h rename to modules/solid_properties/include/solidproperties/ThermalGraphiteProperties.h diff --git a/modules/solid_properties/include/userobjects/ThermalMonolithicSiCProperties.h b/modules/solid_properties/include/solidproperties/ThermalMonolithicSiCProperties.h similarity index 100% rename from modules/solid_properties/include/userobjects/ThermalMonolithicSiCProperties.h rename to modules/solid_properties/include/solidproperties/ThermalMonolithicSiCProperties.h diff --git a/modules/solid_properties/include/userobjects/ThermalSS316Properties.h b/modules/solid_properties/include/solidproperties/ThermalSS316Properties.h similarity index 100% rename from modules/solid_properties/include/userobjects/ThermalSS316Properties.h rename to modules/solid_properties/include/solidproperties/ThermalSS316Properties.h diff --git a/modules/solid_properties/include/userobjects/ThermalSolidProperties.h b/modules/solid_properties/include/solidproperties/ThermalSolidProperties.h similarity index 100% rename from modules/solid_properties/include/userobjects/ThermalSolidProperties.h rename to modules/solid_properties/include/solidproperties/ThermalSolidProperties.h diff --git a/modules/solid_properties/src/userobjects/SolidProperties.C b/modules/solid_properties/src/solidproperties/SolidProperties.C similarity index 100% rename from modules/solid_properties/src/userobjects/SolidProperties.C rename to modules/solid_properties/src/solidproperties/SolidProperties.C diff --git a/modules/solid_properties/src/userobjects/ThermalCompositeSiCProperties.C b/modules/solid_properties/src/solidproperties/ThermalCompositeSiCProperties.C similarity index 100% rename from modules/solid_properties/src/userobjects/ThermalCompositeSiCProperties.C rename to modules/solid_properties/src/solidproperties/ThermalCompositeSiCProperties.C diff --git a/modules/solid_properties/src/userobjects/ThermalFunctionSolidProperties.C b/modules/solid_properties/src/solidproperties/ThermalFunctionSolidProperties.C similarity index 100% rename from modules/solid_properties/src/userobjects/ThermalFunctionSolidProperties.C rename to modules/solid_properties/src/solidproperties/ThermalFunctionSolidProperties.C diff --git a/modules/solid_properties/src/userobjects/ThermalGraphiteProperties.C b/modules/solid_properties/src/solidproperties/ThermalGraphiteProperties.C similarity index 100% rename from modules/solid_properties/src/userobjects/ThermalGraphiteProperties.C rename to modules/solid_properties/src/solidproperties/ThermalGraphiteProperties.C diff --git a/modules/solid_properties/src/userobjects/ThermalMonolithicSiCProperties.C b/modules/solid_properties/src/solidproperties/ThermalMonolithicSiCProperties.C similarity index 100% rename from modules/solid_properties/src/userobjects/ThermalMonolithicSiCProperties.C rename to modules/solid_properties/src/solidproperties/ThermalMonolithicSiCProperties.C diff --git a/modules/solid_properties/src/userobjects/ThermalSS316Properties.C b/modules/solid_properties/src/solidproperties/ThermalSS316Properties.C similarity index 100% rename from modules/solid_properties/src/userobjects/ThermalSS316Properties.C rename to modules/solid_properties/src/solidproperties/ThermalSS316Properties.C diff --git a/modules/solid_properties/src/userobjects/ThermalSolidProperties.C b/modules/solid_properties/src/solidproperties/ThermalSolidProperties.C similarity index 100% rename from modules/solid_properties/src/userobjects/ThermalSolidProperties.C rename to modules/solid_properties/src/solidproperties/ThermalSolidProperties.C diff --git a/modules/solid_properties/test/tests/userobjects/composite_sic/gold/composite_sic_vpp_0000.csv b/modules/solid_properties/test/tests/solidproperties/composite_sic/gold/composite_sic_vpp_0000.csv similarity index 100% rename from modules/solid_properties/test/tests/userobjects/composite_sic/gold/composite_sic_vpp_0000.csv rename to modules/solid_properties/test/tests/solidproperties/composite_sic/gold/composite_sic_vpp_0000.csv diff --git a/modules/solid_properties/test/tests/userobjects/composite_sic/tests b/modules/solid_properties/test/tests/solidproperties/composite_sic/tests similarity index 100% rename from modules/solid_properties/test/tests/userobjects/composite_sic/tests rename to modules/solid_properties/test/tests/solidproperties/composite_sic/tests diff --git a/modules/solid_properties/test/tests/userobjects/functional/gold/functional_vpp_0000.csv b/modules/solid_properties/test/tests/solidproperties/functional/gold/functional_vpp_0000.csv similarity index 100% rename from modules/solid_properties/test/tests/userobjects/functional/gold/functional_vpp_0000.csv rename to modules/solid_properties/test/tests/solidproperties/functional/gold/functional_vpp_0000.csv diff --git a/modules/solid_properties/test/tests/userobjects/functional/tests b/modules/solid_properties/test/tests/solidproperties/functional/tests similarity index 100% rename from modules/solid_properties/test/tests/userobjects/functional/tests rename to modules/solid_properties/test/tests/solidproperties/functional/tests diff --git a/modules/solid_properties/test/tests/userobjects/graphite/gold/graphite_451_vpp_0000.csv b/modules/solid_properties/test/tests/solidproperties/graphite/gold/graphite_451_vpp_0000.csv similarity index 100% rename from modules/solid_properties/test/tests/userobjects/graphite/gold/graphite_451_vpp_0000.csv rename to modules/solid_properties/test/tests/solidproperties/graphite/gold/graphite_451_vpp_0000.csv diff --git a/modules/solid_properties/test/tests/userobjects/graphite/tests b/modules/solid_properties/test/tests/solidproperties/graphite/tests similarity index 100% rename from modules/solid_properties/test/tests/userobjects/graphite/tests rename to modules/solid_properties/test/tests/solidproperties/graphite/tests diff --git a/modules/solid_properties/test/tests/userobjects/monolithic_sic/gold/monolithic_sic_vpp_0000.csv b/modules/solid_properties/test/tests/solidproperties/monolithic_sic/gold/monolithic_sic_vpp_0000.csv similarity index 100% rename from modules/solid_properties/test/tests/userobjects/monolithic_sic/gold/monolithic_sic_vpp_0000.csv rename to modules/solid_properties/test/tests/solidproperties/monolithic_sic/gold/monolithic_sic_vpp_0000.csv diff --git a/modules/solid_properties/test/tests/userobjects/monolithic_sic/tests b/modules/solid_properties/test/tests/solidproperties/monolithic_sic/tests similarity index 100% rename from modules/solid_properties/test/tests/userobjects/monolithic_sic/tests rename to modules/solid_properties/test/tests/solidproperties/monolithic_sic/tests diff --git a/modules/solid_properties/test/tests/userobjects/stainless_steel_316/gold/stainless_steel_316_vpp_0000.csv b/modules/solid_properties/test/tests/solidproperties/stainless_steel_316/gold/stainless_steel_316_vpp_0000.csv similarity index 100% rename from modules/solid_properties/test/tests/userobjects/stainless_steel_316/gold/stainless_steel_316_vpp_0000.csv rename to modules/solid_properties/test/tests/solidproperties/stainless_steel_316/gold/stainless_steel_316_vpp_0000.csv diff --git a/modules/solid_properties/test/tests/userobjects/stainless_steel_316/tests b/modules/solid_properties/test/tests/solidproperties/stainless_steel_316/tests similarity index 100% rename from modules/solid_properties/test/tests/userobjects/stainless_steel_316/tests rename to modules/solid_properties/test/tests/solidproperties/stainless_steel_316/tests diff --git a/modules/solid_properties/test/tests/userobjects/thermal_solid_properties.i b/modules/solid_properties/test/tests/solidproperties/thermal_solid_properties.i similarity index 100% rename from modules/solid_properties/test/tests/userobjects/thermal_solid_properties.i rename to modules/solid_properties/test/tests/solidproperties/thermal_solid_properties.i From 9f002dae12285c0ce37dbb8c3e510f1484c201b8 Mon Sep 17 00:00:00 2001 From: Guillaume Giudicelli Date: Sat, 24 Jun 2023 11:00:18 -0600 Subject: [PATCH 2/4] Rename VPPFunction to give a better idea of what it does refs #20865 --- .../PiecewiseLinearFromVectorPostprocessor.md | 21 ++++++++++++++++++ .../functions/VectorPostprocessorFunction.md | 17 -------------- ... PiecewiseLinearFromVectorPostprocessor.h} | 4 ++-- ... PiecewiseLinearFromVectorPostprocessor.C} | 21 +++++++++++------- .../gold/out.e | Bin .../gold/vpp_time_interpolation_out.csv | 0 .../tests | 6 ++--- .../time_data.csv | 0 .../vector_postprocessor_function.i | 0 .../vpp_time_interpolation.i | 0 10 files changed, 39 insertions(+), 30 deletions(-) create mode 100644 framework/doc/content/source/functions/PiecewiseLinearFromVectorPostprocessor.md delete mode 100644 framework/doc/content/source/functions/VectorPostprocessorFunction.md rename framework/include/functions/{VectorPostprocessorFunction.h => PiecewiseLinearFromVectorPostprocessor.h} (88%) rename framework/src/functions/{VectorPostprocessorFunction.C => PiecewiseLinearFromVectorPostprocessor.C} (78%) rename test/tests/functions/{vector_postprocessor_function => piecewise_linear_from_vectorpostprocessor}/gold/out.e (100%) rename test/tests/functions/{vector_postprocessor_function => piecewise_linear_from_vectorpostprocessor}/gold/vpp_time_interpolation_out.csv (100%) rename test/tests/functions/{vector_postprocessor_function => piecewise_linear_from_vectorpostprocessor}/tests (64%) rename test/tests/functions/{vector_postprocessor_function => piecewise_linear_from_vectorpostprocessor}/time_data.csv (100%) rename test/tests/functions/{vector_postprocessor_function => piecewise_linear_from_vectorpostprocessor}/vector_postprocessor_function.i (100%) rename test/tests/functions/{vector_postprocessor_function => piecewise_linear_from_vectorpostprocessor}/vpp_time_interpolation.i (100%) diff --git a/framework/doc/content/source/functions/PiecewiseLinearFromVectorPostprocessor.md b/framework/doc/content/source/functions/PiecewiseLinearFromVectorPostprocessor.md new file mode 100644 index 000000000000..8ca4b4aa660d --- /dev/null +++ b/framework/doc/content/source/functions/PiecewiseLinearFromVectorPostprocessor.md @@ -0,0 +1,21 @@ +# PiecewiseLinearFromVectorPostprocessor + +!syntax description /Functions/PiecewiseLinearFromVectorPostprocessor + +## Description + +The `PiecewiseLinearFromVectorPostprocessor` function performs linear interpolations between pairs of data generated by a vector post-processor object. The abscissa (`argument_column`) and the ordinate (`value_column`) values should correspond to the names of member vectors of the object specified for the `vectorpostprocessor_name` parameter. By default, the abscissa values correspond to time, and the data will be interpolated at the actual simulation time-step values. However, it is possible to interpolate over spatial (x, y, or z) coordinates by specifying a direction with the `component` parameter, where the inputs, `0`, `1`, and `2`, correspond to the `x`, `y`, and `z` directions, respectively. + +## Example Input Syntax + +In this example, three `PiecewiseLinearFromVectorPostprocessor` are created and take data from three distinct +vector postprocessors. All three functions use a [!param](/Functions/PiecewiseLinearFromVectorPostprocessor/component) +parameter, which is set so they are functions of space rather than time (y for first two, x for the last one). + +!listing test/tests/functions/piecewise_linear_from_vectorpostprocessor/vector_postprocessor_function.i block=Functions VectorPostprocessors + +!syntax parameters /Functions/PiecewiseLinearFromVectorPostprocessor + +!syntax inputs /Functions/PiecewiseLinearFromVectorPostprocessor + +!syntax children /Functions/PiecewiseLinearFromVectorPostprocessor diff --git a/framework/doc/content/source/functions/VectorPostprocessorFunction.md b/framework/doc/content/source/functions/VectorPostprocessorFunction.md deleted file mode 100644 index 155aad80c3fe..000000000000 --- a/framework/doc/content/source/functions/VectorPostprocessorFunction.md +++ /dev/null @@ -1,17 +0,0 @@ -# VectorPostprocessorFunction - -!syntax description /Functions/VectorPostprocessorFunction - -## Description - -The `VectorPostprocessorFunction` function performs linear interpolations between pairs of data generated by a vector post-processor object. The abscissa (`argument_column`) and the ordinate (`value_column`) values should correspond to the names of member vectors of the object specified for the `vectorpostprocessor_name` parameter. By default, the abscissa values correspond to time, and the data will be interpolated at the actual simulation time-step values. However, it is possible to interpolate over spatial (x, y, or z) coordinates by specifying a direction with the `component` parameter, where the inputs, `0`, `1`, and `2`, correspond to the `x`, `y`, and `z` directions, respectively. - -## Example Input Syntax - -!listing test/tests/functions/vector_postprocessor_function/vector_postprocessor_function.i block=Functions - -!syntax parameters /Functions/VectorPostprocessorFunction - -!syntax inputs /Functions/VectorPostprocessorFunction - -!syntax children /Functions/VectorPostprocessorFunction diff --git a/framework/include/functions/VectorPostprocessorFunction.h b/framework/include/functions/PiecewiseLinearFromVectorPostprocessor.h similarity index 88% rename from framework/include/functions/VectorPostprocessorFunction.h rename to framework/include/functions/PiecewiseLinearFromVectorPostprocessor.h index a49f54cf1841..b4f7b502e48e 100644 --- a/framework/include/functions/VectorPostprocessorFunction.h +++ b/framework/include/functions/PiecewiseLinearFromVectorPostprocessor.h @@ -17,12 +17,12 @@ * Function which provides a piecewise continuous linear interpolation * of a data set provided as two columns of a VectorPostprocessor. */ -class VectorPostprocessorFunction : public Function, public VectorPostprocessorInterface +class PiecewiseLinearFromVectorPostprocessor : public Function, public VectorPostprocessorInterface { public: static InputParameters validParams(); - VectorPostprocessorFunction(const InputParameters & parameters); + PiecewiseLinearFromVectorPostprocessor(const InputParameters & parameters); using Function::value; virtual Real value(Real t, const Point & p) const override; diff --git a/framework/src/functions/VectorPostprocessorFunction.C b/framework/src/functions/PiecewiseLinearFromVectorPostprocessor.C similarity index 78% rename from framework/src/functions/VectorPostprocessorFunction.C rename to framework/src/functions/PiecewiseLinearFromVectorPostprocessor.C index 00eb3e75f689..3f2b8db9f334 100644 --- a/framework/src/functions/VectorPostprocessorFunction.C +++ b/framework/src/functions/PiecewiseLinearFromVectorPostprocessor.C @@ -7,12 +7,16 @@ //* Licensed under LGPL 2.1, please see LICENSE for details //* https://www.gnu.org/licenses/lgpl-2.1.html -#include "VectorPostprocessorFunction.h" +#include "PiecewiseLinearFromVectorPostprocessor.h" -registerMooseObject("MooseApp", VectorPostprocessorFunction); +registerMooseObject("MooseApp", PiecewiseLinearFromVectorPostprocessor); +registerMooseObjectRenamed("MooseApp", + VectorPostprocessorFunction, + "02/03/2024 00:00", + PiecewiseLinearFromVectorPostprocessor); InputParameters -VectorPostprocessorFunction::validParams() +PiecewiseLinearFromVectorPostprocessor::validParams() { InputParameters params = Function::validParams(); params.addRequiredParam( @@ -41,7 +45,8 @@ VectorPostprocessorFunction::validParams() return params; } -VectorPostprocessorFunction::VectorPostprocessorFunction(const InputParameters & parameters) +PiecewiseLinearFromVectorPostprocessor::PiecewiseLinearFromVectorPostprocessor( + const InputParameters & parameters) : Function(parameters), VectorPostprocessorInterface(this), _argument_column(getVectorPostprocessorValue("vectorpostprocessor_name", @@ -61,25 +66,25 @@ VectorPostprocessorFunction::VectorPostprocessorFunction(const InputParameters & } catch (std::domain_error & e) { - mooseError("In VectorPostprocessorFunction ", _name, ": ", e.what()); + mooseError("In PiecewiseLinearFromVectorPostprocessor ", _name, ": ", e.what()); } } Real -VectorPostprocessorFunction::value(Real t, const Point & p) const +PiecewiseLinearFromVectorPostprocessor::value(Real t, const Point & p) const { return valueInternal(t, p); } ADReal -VectorPostprocessorFunction::value(const ADReal & t, const ADPoint & p) const +PiecewiseLinearFromVectorPostprocessor::value(const ADReal & t, const ADPoint & p) const { return valueInternal(t, p); } template T -VectorPostprocessorFunction::valueInternal(const T & t, const P & p) const +PiecewiseLinearFromVectorPostprocessor::valueInternal(const T & t, const P & p) const { if (_argument_column.empty()) return 0.0; diff --git a/test/tests/functions/vector_postprocessor_function/gold/out.e b/test/tests/functions/piecewise_linear_from_vectorpostprocessor/gold/out.e similarity index 100% rename from test/tests/functions/vector_postprocessor_function/gold/out.e rename to test/tests/functions/piecewise_linear_from_vectorpostprocessor/gold/out.e diff --git a/test/tests/functions/vector_postprocessor_function/gold/vpp_time_interpolation_out.csv b/test/tests/functions/piecewise_linear_from_vectorpostprocessor/gold/vpp_time_interpolation_out.csv similarity index 100% rename from test/tests/functions/vector_postprocessor_function/gold/vpp_time_interpolation_out.csv rename to test/tests/functions/piecewise_linear_from_vectorpostprocessor/gold/vpp_time_interpolation_out.csv diff --git a/test/tests/functions/vector_postprocessor_function/tests b/test/tests/functions/piecewise_linear_from_vectorpostprocessor/tests similarity index 64% rename from test/tests/functions/vector_postprocessor_function/tests rename to test/tests/functions/piecewise_linear_from_vectorpostprocessor/tests index 3861bdf55d90..0f1a5a443e20 100644 --- a/test/tests/functions/vector_postprocessor_function/tests +++ b/test/tests/functions/piecewise_linear_from_vectorpostprocessor/tests @@ -1,5 +1,5 @@ [Tests] - design = 'VectorPostprocessorFunction.md' + design = 'PiecewiseLinearFromVectorPostprocessor.md' [test_spatial_data] issues = '#8713' @@ -8,7 +8,7 @@ input = 'vector_postprocessor_function.i' exodiff = 'out.e' superlu = true - requirement = "The VectorPostprocessorFunction shall be capable of linear interpolating data " + requirement = "The system shall be capable of linear interpolating data " "generated by a VectorPostprocessor object." [] [test_time_data] @@ -17,7 +17,7 @@ type = CSVDiff input = vpp_time_interpolation.i csvdiff = vpp_time_interpolation_out.csv - requirement = "The VectorPostprocessorFunction shall be capable of linear interpolating data " + requirement = "The system shall be capable of linear interpolating data " "generated by a VPP with respect to time." [] [] diff --git a/test/tests/functions/vector_postprocessor_function/time_data.csv b/test/tests/functions/piecewise_linear_from_vectorpostprocessor/time_data.csv similarity index 100% rename from test/tests/functions/vector_postprocessor_function/time_data.csv rename to test/tests/functions/piecewise_linear_from_vectorpostprocessor/time_data.csv diff --git a/test/tests/functions/vector_postprocessor_function/vector_postprocessor_function.i b/test/tests/functions/piecewise_linear_from_vectorpostprocessor/vector_postprocessor_function.i similarity index 100% rename from test/tests/functions/vector_postprocessor_function/vector_postprocessor_function.i rename to test/tests/functions/piecewise_linear_from_vectorpostprocessor/vector_postprocessor_function.i diff --git a/test/tests/functions/vector_postprocessor_function/vpp_time_interpolation.i b/test/tests/functions/piecewise_linear_from_vectorpostprocessor/vpp_time_interpolation.i similarity index 100% rename from test/tests/functions/vector_postprocessor_function/vpp_time_interpolation.i rename to test/tests/functions/piecewise_linear_from_vectorpostprocessor/vpp_time_interpolation.i From abae0756c7e20794dbc2ce24664d73e1a0f0578b Mon Sep 17 00:00:00 2001 From: Guillaume Giudicelli Date: Thu, 29 Jun 2023 18:04:41 -0600 Subject: [PATCH 3/4] Attempt format fix on VMM vpp --- .../vectorpostprocessors/VectorMemoryUsage.md | 19 ++++++++++++++----- 1 file changed, 14 insertions(+), 5 deletions(-) diff --git a/framework/doc/content/source/vectorpostprocessors/VectorMemoryUsage.md b/framework/doc/content/source/vectorpostprocessors/VectorMemoryUsage.md index 550fb9114729..fe1a8bb89863 100644 --- a/framework/doc/content/source/vectorpostprocessors/VectorMemoryUsage.md +++ b/framework/doc/content/source/vectorpostprocessors/VectorMemoryUsage.md @@ -23,25 +23,34 @@ This VectorPostprocessor can be visualized using the AuxKernel. Both the IDs: -!media media/vectorpostprocessors/ss_grid.png style=width:32%;margin-left:30px;float:left; +!row! + +!media media/vectorpostprocessors/ss_grid.png style=width:32%;float:left; caption=Refined grid -!media media/vectorpostprocessors/ss_processor_id.png style=width:32%;margin-left:30px;float:left +!media media/vectorpostprocessors/ss_processor_id.png style=width:32%;float:left caption=Processor id (using [`ProcessorIDAux`](/ProcessorIDAux.md)) -!media media/vectorpostprocessors/ss_hardware_id.png style=width:32%;margin-left:30px;float:left +!media media/vectorpostprocessors/ss_hardware_id.png style=width:32%;float:left caption=Hardware id (i.e. compute node) +!row-end! and the memory used: +!row! -!media media/vectorpostprocessors/ss_physical_mem.png style=width:32%;margin-left:30px;float:left +!media media/vectorpostprocessors/ss_physical_mem.png style=width:32%;float:left caption=Physical memory used by rank -!media media/vectorpostprocessors/ss_node_utilization.png style=width:32%;margin-left:30px;float:left +!media media/vectorpostprocessors/ss_node_utilization.png style=width:32%;float:left caption=Fraction of RAM used by the current simulation on the compute node +!row-end! + +!alert note +Due to differences in the data collection method, the memory consumption different may be slightly different from +the [PerfGraphOutput.md]. !syntax parameters /VectorPostprocessors/VectorMemoryUsage From 54c581ed8a52cbafa7572b5f5dcdff83be32dbe8 Mon Sep 17 00:00:00 2001 From: Guillaume Giudicelli Date: Mon, 3 Jul 2023 20:28:41 -0600 Subject: [PATCH 4/4] Address Josh's review: - use param syntax for doc page for lienarfromVPP - plural takes an s --- .../functions/PiecewiseLinearFromVectorPostprocessor.md | 4 ++-- .../content/source/vectorpostprocessors/VectorMemoryUsage.md | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/framework/doc/content/source/functions/PiecewiseLinearFromVectorPostprocessor.md b/framework/doc/content/source/functions/PiecewiseLinearFromVectorPostprocessor.md index 8ca4b4aa660d..9e0633f51999 100644 --- a/framework/doc/content/source/functions/PiecewiseLinearFromVectorPostprocessor.md +++ b/framework/doc/content/source/functions/PiecewiseLinearFromVectorPostprocessor.md @@ -4,11 +4,11 @@ ## Description -The `PiecewiseLinearFromVectorPostprocessor` function performs linear interpolations between pairs of data generated by a vector post-processor object. The abscissa (`argument_column`) and the ordinate (`value_column`) values should correspond to the names of member vectors of the object specified for the `vectorpostprocessor_name` parameter. By default, the abscissa values correspond to time, and the data will be interpolated at the actual simulation time-step values. However, it is possible to interpolate over spatial (x, y, or z) coordinates by specifying a direction with the `component` parameter, where the inputs, `0`, `1`, and `2`, correspond to the `x`, `y`, and `z` directions, respectively. +The `PiecewiseLinearFromVectorPostprocessor` function performs linear interpolations between pairs of data generated by a vector post-processor object. The abscissa ([!param](/Functions/PiecewiseLinearFromVectorPostprocessor/argument_column)) and the ordinate ([!param](/Functions/PiecewiseLinearFromVectorPostprocessor/value_column)) values should correspond to the names of member vectors of the object specified for the [!param](/Functions/PiecewiseLinearFromVectorPostprocessor/vectorpostprocessor_name) parameter. By default, the abscissa values correspond to time, and the data will be interpolated at the actual simulation time-step values. However, it is possible to interpolate over spatial (x, y, or z) coordinates by specifying a direction with the [!param](/Functions/PiecewiseLinearFromVectorPostprocessor/component) parameter, where the inputs, `0`, `1`, and `2`, correspond to the `x`, `y`, and `z` directions, respectively. ## Example Input Syntax -In this example, three `PiecewiseLinearFromVectorPostprocessor` are created and take data from three distinct +In this example, three `PiecewiseLinearFromVectorPostprocessor`s are created and take data from three distinct vector postprocessors. All three functions use a [!param](/Functions/PiecewiseLinearFromVectorPostprocessor/component) parameter, which is set so they are functions of space rather than time (y for first two, x for the last one). diff --git a/framework/doc/content/source/vectorpostprocessors/VectorMemoryUsage.md b/framework/doc/content/source/vectorpostprocessors/VectorMemoryUsage.md index fe1a8bb89863..f765929f45f2 100644 --- a/framework/doc/content/source/vectorpostprocessors/VectorMemoryUsage.md +++ b/framework/doc/content/source/vectorpostprocessors/VectorMemoryUsage.md @@ -49,7 +49,7 @@ and the memory used: !row-end! !alert note -Due to differences in the data collection method, the memory consumption different may be slightly different from +Due to differences in the data collection method, the memory consumption may be slightly different from the [PerfGraphOutput.md]. !syntax parameters /VectorPostprocessors/VectorMemoryUsage