From c2ee96cc430ee26c3899a299e24b1a0da90f9c4d Mon Sep 17 00:00:00 2001 From: MarcusHolly <96305519+MarcusHolly@users.noreply.github.com> Date: Fri, 10 May 2024 13:31:20 -0400 Subject: [PATCH] Adding Examples of Unit Model Costing Documentation (#1373) * Create cstr_injection doc * Add unit model costing documentation * Clean up file * Add aeration tank to index * Remove AD from changed files (was changed accidentally) * Address formatting issues * Undo AD doc changes * Correct typo * Replace Default Value column heading with Index * Add reference to CSTR documentation --- .../costing/WT_unit_costing_for_docs.csv | 1 + .../costing/aeration_tank.rst | 48 +++++++++++++++ .../costing/anaerobic_digester.rst | 2 +- .../technical_reference/costing/clarifier.rst | 58 ++++++++++++++----- docs/technical_reference/costing/cstr.rst | 34 ++++------- .../costing/cstr_injection.rst | 33 ++++------- .../costing/detailed_unit_model_costing.rst | 1 + .../costing/dewatering.rst | 42 +++++++++----- .../technical_reference/costing/thickener.rst | 28 +++------ 9 files changed, 148 insertions(+), 99 deletions(-) create mode 100644 docs/technical_reference/costing/aeration_tank.rst diff --git a/docs/technical_reference/costing/WT_unit_costing_for_docs.csv b/docs/technical_reference/costing/WT_unit_costing_for_docs.csv index 2228fd66f4..976de43429 100644 --- a/docs/technical_reference/costing/WT_unit_costing_for_docs.csv +++ b/docs/technical_reference/costing/WT_unit_costing_for_docs.csv @@ -1,4 +1,5 @@ name,unit +aeration tank,aeration_tank anaerobic digester,anaerobic_digester clarifier,clarifier compressor,compressor diff --git a/docs/technical_reference/costing/aeration_tank.rst b/docs/technical_reference/costing/aeration_tank.rst new file mode 100644 index 0000000000..7afa868cc6 --- /dev/null +++ b/docs/technical_reference/costing/aeration_tank.rst @@ -0,0 +1,48 @@ +Aeration Tank Costing Method +============================ + +.. note:: The aeration tank inherits from the CSTR with injection class and uses the same costing relationships. + +Costing Method Parameters ++++++++++++++++++++++++++ + +The following parameters are constructed for the unit on the FlowsheetCostingBlock (e.g., `m.fs.costing.cstr_injection`) when applying the `cost_cstr_injection` costing method in the ``watertap_costing_package``: + +.. csv-table:: + :header: "Description", "Symbol", "Parameter Name", "Default Value", "Units" + + "Capital cost A parameter :math:`^1`", ":math:`A`", "capital_a_parameter", "1.1141e3", ":math:`\text{USD}_{1997}`" + "Capital cost B parameter :math:`^1`", ":math:`B`", "capital_b_parameter", "0.6", ":math:`\text{dimensionless}`" + +Costing Method Variables +++++++++++++++++++++++++ + +There are no costing method variables unique to the aeration tank. + +Capital Cost Calculations ++++++++++++++++++++++++++ + +Capital cost is dependent upon the unit's volume, :math:`V`, as shown in the equation below. + + .. math:: + + C_{cap,tot} = A * V^{B} + + +Operating Cost Calculations ++++++++++++++++++++++++++++ + +There are no operating costs unique to the aeration tank. + + +Code Documentation +------------------ + +* :mod:`watertap.costing.unit_models.cstr_injection` + +References +---------- +[1] Eberle, Annika, Irina Tsiryapkina, Steve Peterson, Laura Vimmerstedt, Dylan Hettinger, +and Daniel Inman. 2020. An Overview of the Waste-to-Energy System Simulation +(WESyS) Model. Golden, CO: National Renewable Energy Laboratory. +NREL/TP-6A20-77166. https://www.nrel.gov/docs/fy21osti/77166.pdf. \ No newline at end of file diff --git a/docs/technical_reference/costing/anaerobic_digester.rst b/docs/technical_reference/costing/anaerobic_digester.rst index 98cfb9d5a8..7f673b5f2d 100644 --- a/docs/technical_reference/costing/anaerobic_digester.rst +++ b/docs/technical_reference/costing/anaerobic_digester.rst @@ -34,7 +34,7 @@ Describe capital costs..keep it concise where possible C_{cap,example1} = fill in equation for each component in total capex equation - + Operating Cost Calculations +++++++++++++++++++++++++++ diff --git a/docs/technical_reference/costing/clarifier.rst b/docs/technical_reference/costing/clarifier.rst index ff3cb35510..c77f7bc2c3 100644 --- a/docs/technical_reference/costing/clarifier.rst +++ b/docs/technical_reference/costing/clarifier.rst @@ -1,6 +1,10 @@ Clarifier Costing Method ========================= +There are three classes of clarifier costing types (circular, rectangular, and primary), each with their own parameters, variables, +and costing relationships. The default configuration is a circular clarifier, so users must manually change the clarifier type +if they wish to invoke the costing method for rectangular or primary clarifiers. + Costing Method Parameters +++++++++++++++++++++++++ @@ -9,7 +13,19 @@ The following parameters are constructed for the unit on the FlowsheetCostingBlo .. csv-table:: :header: "Description", "Symbol", "Parameter Name", "Default Value", "Units" - "description", ":math:`Symbol_{example}`", "parameter_name", "1", ":math:`\text{dimensionless}`" + "**Circular clarifier**" + "Capital cost A parameter :math:`^1`", ":math:`A_{circular}`", "construction_a_parameter", "-6e-4", ":math:`\text{USD}_{2011}\text{/ft}^4`" + "Capital cost B parameter :math:`^1`", ":math:`B_{circular}`", "construction_b_parameter", "98.952", ":math:`\text{USD}_{2011}\text{/ft}^2`" + "Capital cost C parameter :math:`^1`", ":math:`C_{circular}`", "construction_c_parameter", "191806", ":math:`\text{USD}_{2011}`" + + "**Rectangular clarifier**" + "Capital cost A parameter :math:`^1`", ":math:`A_{rectangular}`", "construction_a_parameter", "-2.9e-3", ":math:`\text{USD}_{2011}\text{/ft}^4`" + "Capital cost B parameter :math:`^1`", ":math:`B_{rectangular}`", "construction_b_parameter", "169.19", ":math:`\text{USD}_{2011}\text{/ft}^2`" + "Capital cost C parameter :math:`^1`", ":math:`C_{rectangular}`", "construction_c_parameter", "94365", ":math:`\text{USD}_{2011}`" + + "**Primary clarifier**" + "Capital cost A parameter :math:`^2`", ":math:`A_{primary}`", "capital_a_parameter", "-2.9e-3", ":math:`\text{USD}_{2021}`" + "Capital cost B parameter :math:`^2`", ":math:`B_{primary}`", "capital_b_parameter", "538746.398", ":math:`\text{dimensionless}`" Costing Method Variables ++++++++++++++++++++++++ @@ -17,36 +33,40 @@ Costing Method Variables The following variables are constructed on the unit block (e.g., m.fs.unit.costing) when applying the `cost_clarifier` costing method in the ``watertap_costing_package``: .. csv-table:: - :header: "Description", "Symbol", "Variable Name", "Default Value", "Units" + :header: "Description", "Symbol", "Variable Name", "Index", "Units" + + "**Circular clarifier**" + "Surface area", ":math:`A_{s}`", "surface_area", "None", ":math:`\text{ft}^2`" - "description", ":math:`Symbol_{example}`", "variable_name", "1", ":math:`\text{dimensionless}`" + "**Rectangular clarifier**" + "Surface area", ":math:`A_{s}`", "surface_area", "None", ":math:`\text{ft}^2`" + + "**Primary clarifier**" + "Inlet volumetric flow rate", ":math:`Q_{in}`", "flow_in", "[t]", ":math:`\text{gal/day}`" Capital Cost Calculations +++++++++++++++++++++++++ -Describe capital costs..keep it concise where possible +For the circular and rectangular clarifiers, capital cost is dependent upon the surface area, :math:`A_{s}`, whereas the capital cost of +the primary clarifier is based on the volumetric flow rate :math:`Q_{in}`. .. math:: - C_{cap,tot} = C_{cap,example1}+C_{cap,example2}+C_{cap,other} + C_{cap,circular} = A_{circular} * A_{s}^{2} + B_{circular} * A_{s} + C_{circular} .. math:: - C_{cap,example1} = fill in equation for each component in total capex equation - - -Operating Cost Calculations -+++++++++++++++++++++++++++ - -Describe operating/maintenance costs..keep it concise where possible + C_{cap,rectangular} = A_{rectangular} * A_{s}^{2} + B_{rectangular} * A_{s} + C_{rectangular} .. math:: - C_{op,tot} = C_{op,example1}+C_{op,example2}+C_{op,other} + C_{cap,primary} = A_{primary} * Q_{in}^{B_{primary}} - .. math:: + +Operating Cost Calculations ++++++++++++++++++++++++++++ - C_{op,example1} = fill in equation for each component in total opex equation +There are no operating costs unique to the clarifier. Code Documentation @@ -56,4 +76,10 @@ Code Documentation References ---------- -Aim to include at least one reference in most cases, but delete this section if no references used for cost relationships/default values \ No newline at end of file +[1] Sharma, Jwala R., Mohammad Najafi, and Syed R. Qasim. +"Preliminary cost estimation models for construction, operation, and maintenance of water treatment plants." +Journal of Infrastructure Systems 19.4 (2013): 451-464. + +[2] Byun, Jaewon, Maravelias, Christos. +Benchmark Model for Wastewater Treatment Using an Activated Sludge Process. +United States: N.p., 21 Jan, 2022. Web. doi: 10.7481/1844539. \ No newline at end of file diff --git a/docs/technical_reference/costing/cstr.rst b/docs/technical_reference/costing/cstr.rst index e78bc4845e..400b5a981b 100644 --- a/docs/technical_reference/costing/cstr.rst +++ b/docs/technical_reference/costing/cstr.rst @@ -9,45 +9,28 @@ The following parameters are constructed for the unit on the FlowsheetCostingBlo .. csv-table:: :header: "Description", "Symbol", "Parameter Name", "Default Value", "Units" - "description", ":math:`Symbol_{example}`", "parameter_name", "1", ":math:`\text{dimensionless}`" + "Capital cost A parameter :math:`^1`", ":math:`A`", "capital_a_parameter", "1246.1", ":math:`\text{USD}_{1990}`" + "Capital cost B parameter :math:`^1`", ":math:`B`", "capital_b_parameter", "0.71", ":math:`\text{dimensionless}`" Costing Method Variables ++++++++++++++++++++++++ -The following variables are constructed on the unit block (e.g., m.fs.unit.costing) when applying the `cost_cstr` costing method in the ``watertap_costing_package``: - -.. csv-table:: - :header: "Description", "Symbol", "Variable Name", "Default Value", "Units" - - "description", ":math:`Symbol_{example}`", "variable_name", "1", ":math:`\text{dimensionless}`" +There are no costing method variables unique to the CSTR. Capital Cost Calculations +++++++++++++++++++++++++ -Describe capital costs..keep it concise where possible +Capital cost is dependent upon the unit's volume, :math:`V`, as shown in the equation below. .. math:: - C_{cap,tot} = C_{cap,example1}+C_{cap,example2}+C_{cap,other} - - .. math:: - - C_{cap,example1} = fill in equation for each component in total capex equation + C_{cap,tot} = A * V^{B} Operating Cost Calculations +++++++++++++++++++++++++++ -Describe operating/maintenance costs..keep it concise where possible - - .. math:: - - C_{op,tot} = C_{op,example1}+C_{op,example2}+C_{op,other} - - .. math:: - - C_{op,example1} = fill in equation for each component in total opex equation - +There are no operating costs unique to the CSTR. Code Documentation ------------------ @@ -56,4 +39,7 @@ Code Documentation References ---------- -Aim to include at least one reference in most cases, but delete this section if no references used for cost relationships/default values \ No newline at end of file +[1] Eberle, Annika, Irina Tsiryapkina, Steve Peterson, Laura Vimmerstedt, Dylan Hettinger, +and Daniel Inman. 2020. An Overview of the Waste-to-Energy System Simulation +(WESyS) Model. Golden, CO: National Renewable Energy Laboratory. +NREL/TP-6A20-77166. https://www.nrel.gov/docs/fy21osti/77166.pdf. \ No newline at end of file diff --git a/docs/technical_reference/costing/cstr_injection.rst b/docs/technical_reference/costing/cstr_injection.rst index e8d9b6da61..0a7fa8ab27 100644 --- a/docs/technical_reference/costing/cstr_injection.rst +++ b/docs/technical_reference/costing/cstr_injection.rst @@ -9,44 +9,28 @@ The following parameters are constructed for the unit on the FlowsheetCostingBlo .. csv-table:: :header: "Description", "Symbol", "Parameter Name", "Default Value", "Units" - "description", ":math:`Symbol_{example}`", "parameter_name", "1", ":math:`\text{dimensionless}`" + "Capital cost A parameter :math:`^1`", ":math:`A`", "capital_a_parameter", "1.1141e3", ":math:`\text{USD}_{1997}`" + "Capital cost B parameter :math:`^1`", ":math:`B`", "capital_b_parameter", "0.6", ":math:`\text{dimensionless}`" Costing Method Variables ++++++++++++++++++++++++ -The following variables are constructed on the unit block (e.g., m.fs.unit.costing) when applying the `cost_cstr_injection` costing method in the ``watertap_costing_package``: - -.. csv-table:: - :header: "Description", "Symbol", "Variable Name", "Default Value", "Units" - - "description", ":math:`Symbol_{example}`", "variable_name", "1", ":math:`\text{dimensionless}`" +There are no costing method variables unique to the CSTR with injection Capital Cost Calculations +++++++++++++++++++++++++ -Describe capital costs..keep it concise where possible - - .. math:: - - C_{cap,tot} = C_{cap,example1}+C_{cap,example2}+C_{cap,other} +Capital cost is dependent upon the unit's volume, :math:`V`, as shown in the equation below. .. math:: - C_{cap,example1} = fill in equation for each component in total capex equation + C_{cap,tot} = A * V^{B} Operating Cost Calculations +++++++++++++++++++++++++++ -Describe operating/maintenance costs..keep it concise where possible - - .. math:: - - C_{op,tot} = C_{op,example1}+C_{op,example2}+C_{op,other} - - .. math:: - - C_{op,example1} = fill in equation for each component in total opex equation +There are no operating costs unique to the CSTR with injection. Code Documentation @@ -56,4 +40,7 @@ Code Documentation References ---------- -Aim to include at least one reference in most cases, but delete this section if no references used for cost relationships/default values \ No newline at end of file +[1] Eberle, Annika, Irina Tsiryapkina, Steve Peterson, Laura Vimmerstedt, Dylan Hettinger, +and Daniel Inman. 2020. An Overview of the Waste-to-Energy System Simulation +(WESyS) Model. Golden, CO: National Renewable Energy Laboratory. +NREL/TP-6A20-77166. https://www.nrel.gov/docs/fy21osti/77166.pdf. \ No newline at end of file diff --git a/docs/technical_reference/costing/detailed_unit_model_costing.rst b/docs/technical_reference/costing/detailed_unit_model_costing.rst index 894befc2af..03613bfeb2 100644 --- a/docs/technical_reference/costing/detailed_unit_model_costing.rst +++ b/docs/technical_reference/costing/detailed_unit_model_costing.rst @@ -5,6 +5,7 @@ Default costing methods are provided for the unit models listed below. However, .. toctree:: :maxdepth: 1 + aeration_tank anaerobic_digester clarifier compressor diff --git a/docs/technical_reference/costing/dewatering.rst b/docs/technical_reference/costing/dewatering.rst index 7dc8dac571..5a3f67d4fe 100644 --- a/docs/technical_reference/costing/dewatering.rst +++ b/docs/technical_reference/costing/dewatering.rst @@ -1,6 +1,10 @@ Dewatering Unit Costing Method =============================== +There are three classes of dewatering costing types (centrifuge, filter belt press, and filter plate press), each with their own parameters, variables, +and costing relationships. The default configuration is a centrifuge, so users must manually change the dewatering type +if they wish to invoke the costing method for filter belt press or filter plate press dewatering units. + Costing Method Parameters +++++++++++++++++++++++++ @@ -9,7 +13,17 @@ The following parameters are constructed for the unit on the FlowsheetCostingBlo .. csv-table:: :header: "Description", "Symbol", "Parameter Name", "Default Value", "Units" - "description", ":math:`Symbol_{example}`", "parameter_name", "1", ":math:`\text{dimensionless}`" + "**Centrifuge**" + "Capital cost A parameter :math:`^1`", ":math:`A_{centrifuge}`", "capital_a_parameter", "328.03", ":math:`\text{USD}_{2007}\text{/gal/hr}`" + "Capital cost B parameter :math:`^1`", ":math:`B_{centrifuge}`", "capital_b_parameter", "751295", ":math:`\text{USD}_{2007}`" + + "**Filter belt press**" + "Capital cost A parameter :math:`^1`", ":math:`A_{fbp}`", "capital_a_parameter", "146.29", ":math:`\text{USD}_{2007}\text{/gal/hr}`" + "Capital cost B parameter :math:`^1`", ":math:`B_{fbp}`", "capital_b_parameter", "433972", ":math:`\text{USD}_{2007}`" + + "**Filter plate press**" + "Capital cost A parameter :math:`^1`", ":math:`A_{fpp}`", "capital_a_parameter", "102794", ":math:`\text{USD}_{2007}\text{/gal/hr}`" + "Capital cost B parameter :math:`^1`", ":math:`B_{fpp}`", "capital_b_parameter", "0.4216", ":math:`\text{USD}_{2007}`" Costing Method Variables ++++++++++++++++++++++++ @@ -17,36 +31,31 @@ Costing Method Variables The following variables are constructed on the unit block (e.g., m.fs.unit.costing) when applying the `cost_dewatering` costing method in the ``watertap_costing_package``: .. csv-table:: - :header: "Description", "Symbol", "Variable Name", "Default Value", "Units" + :header: "Description", "Symbol", "Variable Name", "Index", "Units" - "description", ":math:`Symbol_{example}`", "variable_name", "1", ":math:`\text{dimensionless}`" + "Inlet volumetric flow rate", ":math:`Q_{in}`", "flow_in", "[t]", ":math:`\text{gal/hr}`" Capital Cost Calculations +++++++++++++++++++++++++ -Describe capital costs..keep it concise where possible +Capital cost is dependent upon the volumetric flow rate, :math:`Q_{in}`, as shown in the equations below. .. math:: - C_{cap,tot} = C_{cap,example1}+C_{cap,example2}+C_{cap,other} + C_{cap,centrifuge} = A_{centrifuge} * Q_{in} + B_{centrifuge} .. math:: - C_{cap,example1} = fill in equation for each component in total capex equation + C_{cap,fbp} = A_{fbp} * Q_{in} + B_{fbp} + .. math:: + + C_{cap,fpp} = A_{fpp} * Q_{in} + B_{fpp} Operating Cost Calculations +++++++++++++++++++++++++++ -Describe operating/maintenance costs..keep it concise where possible - - .. math:: - - C_{op,tot} = C_{op,example1}+C_{op,example2}+C_{op,other} - - .. math:: - - C_{op,example1} = fill in equation for each component in total opex equation +There are no operating costs unique to the dewatering unit. Code Documentation @@ -56,4 +65,5 @@ Code Documentation References ---------- -Aim to include at least one reference in most cases, but delete this section if no references used for cost relationships/default values \ No newline at end of file +[1] W. McGivney, S. Kawamura, Cost estimating manual for water treatment facilities, +John Wiley & Sons, 2008. http://onlinelibrary.wiley.com/book/10.1002/9780470260036. \ No newline at end of file diff --git a/docs/technical_reference/costing/thickener.rst b/docs/technical_reference/costing/thickener.rst index 1beb331f74..4362d706b6 100644 --- a/docs/technical_reference/costing/thickener.rst +++ b/docs/technical_reference/costing/thickener.rst @@ -9,7 +9,8 @@ The following parameters are constructed for the unit on the FlowsheetCostingBlo .. csv-table:: :header: "Description", "Symbol", "Parameter Name", "Default Value", "Units" - "description", ":math:`Symbol_{example}`", "parameter_name", "1", ":math:`\text{dimensionless}`" + "Capital cost A parameter :math:`^1`", ":math:`A`", "capital_a_parameter", "4729.8", ":math:`\text{USD}_{2011}\text{/ft}`" + "Capital cost B parameter :math:`^1`", ":math:`B`", "capital_b_parameter", "37068", ":math:`\text{USD}_{2007}`" Costing Method Variables ++++++++++++++++++++++++ @@ -17,36 +18,24 @@ Costing Method Variables The following variables are constructed on the unit block (e.g., m.fs.unit.costing) when applying the `cost_thickener` costing method in the ``watertap_costing_package``: .. csv-table:: - :header: "Description", "Symbol", "Variable Name", "Default Value", "Units" + :header: "Description", "Symbol", "Variable Name", "Index", "Units" - "description", ":math:`Symbol_{example}`", "variable_name", "1", ":math:`\text{dimensionless}`" + "Diameter", ":math:`d`", "diameter", "[t]", ":math:`\text{ft}`" Capital Cost Calculations +++++++++++++++++++++++++ -Describe capital costs..keep it concise where possible +Capital cost is dependent upon the thickener diameter, :math:`d`, as shown in the equations below. .. math:: - C_{cap,tot} = C_{cap,example1}+C_{cap,example2}+C_{cap,other} - - .. math:: - - C_{cap,example1} = fill in equation for each component in total capex equation + C_{cap,tot} = A * d + B Operating Cost Calculations +++++++++++++++++++++++++++ -Describe operating/maintenance costs..keep it concise where possible - - .. math:: - - C_{op,tot} = C_{op,example1}+C_{op,example2}+C_{op,other} - - .. math:: - - C_{op,example1} = fill in equation for each component in total opex equation +There are no operating costs unique to the thickener. Code Documentation @@ -56,4 +45,5 @@ Code Documentation References ---------- -Aim to include at least one reference in most cases, but delete this section if no references used for cost relationships/default values \ No newline at end of file +[1] W. McGivney, S. Kawamura, Cost estimating manual for water treatment facilities, +John Wiley & Sons, 2008. http://onlinelibrary.wiley.com/book/10.1002/9780470260036. \ No newline at end of file