Home > matpower7.1 > lib > @opf_model > build_cost_params.m

build_cost_params

PURPOSE ^

BUILD_COST_PARAMS Builds and saves the full generalized cost parameters.

SYNOPSIS ^

function om = build_cost_params(om, force)

DESCRIPTION ^

BUILD_COST_PARAMS  Builds and saves the full generalized cost parameters.

   -----  DEPRECATED - This method is no longer needed,       -----
   -----               incorporated into PARAMS_LEGACY_COST   -----

   OM.BUILD_COST_PARAMS()
   OM.BUILD_COST_PARAMS('force')

   Builds the full set of cost parameters from the individual named
   sub-sets added via ADD_COSTS. Skips the building process if it has
   already been done, unless a second input argument is present.

   These cost parameters can be retrieved by calling GET_COST_PARAMS
   and the user-defined costs evaluated by calling COMPUTE_COST.

   See also OPT_MODEL, ADD_COSTS, PARAMS_LEGACY_COST, GET_COST_PARAMS,
   COMPUTE_COST.

CROSS-REFERENCE INFORMATION ^

This function calls: This function is called by:

SOURCE CODE ^

0001 function om = build_cost_params(om, force)
0002 %BUILD_COST_PARAMS  Builds and saves the full generalized cost parameters.
0003 %
0004 %   -----  DEPRECATED - This method is no longer needed,       -----
0005 %   -----               incorporated into PARAMS_LEGACY_COST   -----
0006 %
0007 %   OM.BUILD_COST_PARAMS()
0008 %   OM.BUILD_COST_PARAMS('force')
0009 %
0010 %   Builds the full set of cost parameters from the individual named
0011 %   sub-sets added via ADD_COSTS. Skips the building process if it has
0012 %   already been done, unless a second input argument is present.
0013 %
0014 %   These cost parameters can be retrieved by calling GET_COST_PARAMS
0015 %   and the user-defined costs evaluated by calling COMPUTE_COST.
0016 %
0017 %   See also OPT_MODEL, ADD_COSTS, PARAMS_LEGACY_COST, GET_COST_PARAMS,
0018 %   COMPUTE_COST.
0019 
0020 %   MATPOWER
0021 %   Copyright (c) 2008-2017, Power Systems Engineering Research Center (PSERC)
0022 %   by Ray Zimmerman, PSERC Cornell
0023 %
0024 %   This file is part of MATPOWER.
0025 %   Covered by the 3-clause BSD License (see LICENSE file for details).
0026 %   See https://matpower.org for more info.
0027 
0028 if nargin > 1
0029     om.cost.params = [];        %% clear cache
0030 end
0031 cp = om.params_legacy_cost();   %% compute and cache full cost parameters

Generated on Fri 09-Oct-2020 11:21:31 by m2html © 2005