This module provides FunctionalFuncOpts, which controls options
for the Fun3D adjoint-based mesh adaptation system using dual.
-
class cape.pyfun.options.functionalopts.FunctionalCoeffCollectionOpts(*args, **kw)
-
get_FunctionalCoeffOpt(coeff: str, opt: str, j=None, **kw)
Get option for a specific functional coefficient
- Call:
>>> v = opts.get_FunctionalCoeffOpt(coeff, opt, j=None, **kw)
- Inputs:
- opts:
OptionsDict Options interface
- coeff:
str Name of coefficient
- opt:
str Name of functional option
- Outputs:
- v:
object Value of opts[fn][opt] or as appropriate
- Versions:
-
-
class cape.pyfun.options.functionalopts.FunctionalCoeffOpts(*args, **kw)
-
class cape.pyfun.options.functionalopts.FunctionalFuncCollectionOpts(*args, **kw)
-
get_FunctionalFuncOpt(fn: str, opt: str, j=None, **kw)
Get option for a specific functional function
- Call:
>>> v = opts.get_FunctionalFuncOpt(fn, opt, j=None, **kw)
- Inputs:
- opts:
OptionsDict Options interface
- fn:
str Name of function
- opt:
str Name of functional option
- Outputs:
- v:
object Value of opts[fn][opt] or as appropriate
- Versions:
-
-
get_FunctionalFuncsByType(typ: str)
Get list of functions by type
- Call:
>>> funcs = opts.get_FunctionalFuncsByType(typ)
- Inputs:
- opts:
OptionsDict Options interface
- typ:
str Requested type
- Outputs:
- funcs:
list[str] List of function names
- Versions:
2016-04-25 @ddalle: v1.0
2023-05-16 @ddalle: v2.0
-
class cape.pyfun.options.functionalopts.FunctionalFuncOpts(*args, **kw)
-
class cape.pyfun.options.functionalopts.FunctionalOpts(*args, **kw)
-
get_FunctionalAdaptCoeffs()
Get list of coefficients in any adaptation function
- Call:
>>> coeffs = opts.get_AdaptCoeffs()
- Inputs:
- opts:
pyFun.options.Options Options interface
- Ouutputs:
- coeffs:
list[str] List of coefficients in the adaptive function
- Versions:
-
-
get_FunctionalCoeffOpt(coeff: str, opt: str, j=None, **kw)
Get option for a specific functional coefficient
- Call:
>>> v = opts.get_FunctionalCoeffOpt(coeff, opt, j=None, **kw)
- Inputs:
- opts:
OptionsDict Options interface
- coeff:
str Name of coefficient
- opt:
str Name of functional option
- Outputs:
- v:
object Value of opts[fn][opt] or as appropriate
- Versions:
-
-
get_FunctionalFuncOpt(fn: str, opt: str, j=None, **kw)
Get option for a specific functional function
- Call:
>>> v = opts.get_FunctionalFuncOpt(fn, opt, j=None, **kw)
- Inputs:
- opts:
OptionsDict Options interface
- fn:
str Name of function
- opt:
str Name of functional option
- Outputs:
- v:
object Value of opts[fn][opt] or as appropriate
- Versions:
-
-
get_FunctionalFuncsByType(typ: str)
Get list of functions by type
- Call:
>>> funcs = opts.get_FunctionalFuncsByType(typ)
- Inputs:
- opts:
OptionsDict Options interface
- typ:
str Requested type
- Outputs:
- funcs:
list[str] List of function names
- Versions:
2016-04-25 @ddalle: v1.0
2023-05-16 @ddalle: v2.0
