13333083280

Committed 13 Feb 2025 10:01PM UTC coverage: 56.892% (-21.9%) from 78.802%

Build # 13333083280

Build Type

push

github

Committed by

web-flow

Commit Message

WEIS v1.5 (#351)

* Viz tool integration (#301)

* utils update for viz tool

* hotfix for length error in viz utils

* slightly improved hotfix

* trim edge case

* working integration with weis

* add text field for reloading diff yaml file

* f-string typo fix to pass py3.11 unit test

* remove duplicated fields on raft opt

* elevate 'weis_viz' to a command within the conda env

* add optimization type

* reformating vizgen and adding 'weis_viz_input_gen' as a command

---------

Co-authored-by: Cory Frontin <cory.frontin@nrel.gov>
Co-authored-by: sryu <Sora.Ryu@nrel.gov>
Co-authored-by: Sora Ryu <sryu@x1007c0s0b0n0.hsn.cm.kestrel.hpc.nrel.gov>
Co-authored-by: Sora Ryu <sryu@kl3.head.cm.kestrel.hpc.nrel.gov>

* bug fix in vizFileGen and changes to handle Jul 2024 Kestrel updates (#306)

* bug fix in vizFileGen and fixes to handle Jul 2024 Kestrel updates

* change type settings and default channels

* match type with WEIS level

* minor update on type setting - dlc

---------

Co-authored-by: Sora Ryu <sryu@x1000c0s0b0n0.hsn.cm.kestrel.hpc.nrel.gov>
Co-authored-by: Sora Ryu <sryu@kl2.head.cm.kestrel.hpc.nrel.gov>

* no need to manipulate turbsim grid for olaf anymore (#313)

* Debug arg parsing error while launching the app & Contribute Initial Documentation (#307)

* fix bug of args parse while running app

* delete unnecessary prints

* change horizontal subplots to vertical ones

* initial documentation

* delete readme file

* minor changes on graph layout

* update on kestrel set up

* merge weis viz docs into existing weis docs

* delete initial weis viz documentation

* update on docs after changing opt type setting

* Revise documentation

---------

Co-authored-by: sryu <Sora.Ryu@nrel.gov>
Co-authored-by: dzalkind <dzalkind@nrel.gov>

* Remove duplicate numpydoc

* Sync readthedocs yaml with WISDEM

* Add numpydoc to environment

* Set up readthedocs inputs: css, js, bibtex

*... (continued)

Run Details

924 of 1787 new or added lines in 30 files covered. (51.71%)

206 existing lines in 8 files now uncovered.

6241 of 10970 relevant lines covered (56.89%)

0.6 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

75.7

/weis/glue_code/gc_LoadInputs.py

import os
import os.path as osp
import copy, logging
import numpy as np

from rosco import discon_lib_path
import weis.inputs as sch
from openfast_io.FAST_reader import InputReader_OpenFAST
from wisdem.glue_code.gc_LoadInputs import WindTurbineOntologyPython
from weis.dlc_driver.dlc_generator    import DLCGenerator
from openmdao.utils.mpi import MPI
from rosco.toolbox.inputs.validation import load_rosco_yaml
from wisdem.inputs import load_yaml

logger = logging.getLogger("wisdem/weis")

def update_options(options,override):
    for key, value in override.items():
        if isinstance(value, dict) and key in options:
            update_options(options[key], value)
        elif key in options:
            options[key] = value
        else:
            raise Exception(f'Error updating option overrides. {key} is not part of {options.keys()}')

class WindTurbineOntologyPythonWEIS(WindTurbineOntologyPython):
    # Pure python class inheriting the class WindTurbineOntologyPython from WISDEM
    # and adding the WEIS options, namely the paths to the WEIS submodules
    # (OpenFAST, ROSCO, TurbSim, XFoil) and initializing the control parameters.

    def __init__(
            self, 
            fname_input_wt, 
            fname_input_modeling, 
            fname_input_analysis,
            modeling_override = None,
            analysis_override = None,
            ):

        self.modeling_options = sch.load_modeling_yaml(fname_input_modeling)
        self.modeling_options['fname_input_modeling'] = fname_input_modeling
        self.wt_init          = sch.load_geometry_yaml(fname_input_wt)
        self.analysis_options = sch.load_analysis_yaml(fname_input_analysis)
        self.analysis_options['fname_input_analysis'] = fname_input_analysis

        # Update options to maintain some backwards compatibility
        self.backwards_compatibility()

        if modeling_override:
            update_options(self.modeling_options, modeling_override)
            sch.re_validate_modeling(self.modeling_options)
                
        
        if analysis_override:
            update_options(self.analysis_options, analysis_override)
            sch.re_validate_analysis(self.analysis_options)

        self.set_run_flags()
        self.set_openmdao_vectors()
        self.set_openmdao_vectors_control()
        self.set_weis_data()
        self.set_opt_flags()

    def set_weis_data(self):

        # Directory of modeling option input, if we want to use it for relative paths
        mod_opt_dir = osp.split(self.modeling_options['fname_input_modeling'])[0]

        # OpenFAST prefixes
        if self.modeling_options['General']['openfast_configuration']['OF_run_fst'] in ['','None','NONE','none']:
            self.modeling_options['General']['openfast_configuration']['OF_run_fst'] = 'weis_job'
            
        if self.modeling_options['General']['openfast_configuration']['OF_run_dir'] in ['','None','NONE','none']:
            self.modeling_options['General']['openfast_configuration']['OF_run_dir'] = osp.join(
                mod_opt_dir,        # If it's a relative path, will be relative to mod_opt directory
                self.analysis_options['general']['folder_output'], 
                'openfast_runs'
                )

        # BEM dir, all levels
        base_run_dir = os.path.join(mod_opt_dir,self.modeling_options['General']['openfast_configuration']['OF_run_dir'])
        if MPI:
            rank    = MPI.COMM_WORLD.Get_rank()
            bemDir = osp.join(base_run_dir,'rank_%000d'%int(rank),'BEM')
        else:
            bemDir = osp.join(base_run_dir,'BEM')

        self.modeling_options["RAFT"]['BEM_dir'] = bemDir
        if MPI:
            # If running MPI, RAFT won't be able to save designs in parallel
            self.modeling_options["RAFT"]['save_designs'] = False


        # Openfast
        if self.modeling_options['OpenFAST_Linear']['flag'] or self.modeling_options['OpenFAST']['flag']:
            fast = InputReader_OpenFAST()
            self.modeling_options['General']['openfast_configuration']['fst_vt'] = {}
            self.modeling_options['General']['openfast_configuration']['fst_vt']['outlist'] = fast.fst_vt['outlist']

                
            # User-defined control dylib (path2dll)
            path2dll = self.modeling_options['General']['openfast_configuration']['path2dll']
            if path2dll == 'none':   #Default option, use above
                self.modeling_options['General']['openfast_configuration']['path2dll'] = discon_lib_path
            else:
                if not osp.isabs(path2dll):  # make relative path absolute
                    self.modeling_options['General']['openfast_configuration']['path2dll'] = \
                        osp.join(osp.dirname(self.options['modeling_options']['fname_input_modeling']), path2dll)
            path2dll = self.modeling_options['General']['openfast_configuration']['path2dll']
            if not osp.exists( path2dll ):
                raise NameError("Cannot find DISCON library: "+path2dll)

            # Activate HAMS in RAFT if requested for OpenFAST
            if self.modeling_options["flags"]["offshore"] or self.modeling_options["OpenFAST"]["from_openfast"]:
                if self.modeling_options["RAFT"]["potential_model_override"] == 2:
                    self.modeling_options["OpenFAST"]["HydroDyn"]["PotMod"] = 1
                elif ( (self.modeling_options["RAFT"]["potential_model_override"] == 0) and
                       (len(self.modeling_options["RAFT"]["potential_bem_members"]) > 0) ):
                    self.modeling_options["OpenFAST"]["HydroDyn"]["PotMod"] = 1
                elif self.modeling_options["RAFT"]["potential_model_override"] == 1:
                    self.modeling_options["OpenFAST"]["HydroDyn"]["PotMod"] = 0
                else:
                    # Keep user defined value of PotMod
                    pass

                if self.modeling_options["OpenFAST"]["HydroDyn"]["PotMod"] == 1:

                    # If user requested PotMod but didn't specify any override or members, just run everything
                    if ( (self.modeling_options["RAFT"]["potential_model_override"] == 0) and
                       (len(self.modeling_options["RAFT"]["potential_bem_members"]) == 0) ):
                        self.modeling_options["RAFT"]["potential_model_override"] == 2
                        
                    cwd = os.getcwd()
                    weis_dir = osp.dirname(osp.dirname(osp.dirname(osp.abspath(__file__))))
                    potpath = self.modeling_options["OpenFAST"]["HydroDyn"]["PotFile"].replace('.hst','').replace('.12','').replace('.3','').replace('.1','')
                    if ( (len(potpath) == 0) or (potpath.lower() in ['unused','default','none']) ):
                        
                        self.modeling_options['RAFT']['flag'] = True
                        self.modeling_options["OpenFAST"]["HydroDyn"]["PotFile"] = osp.join(bemDir,'Output','Wamit_format','Buoy')
                        

                    else:
                        if self.modeling_options['RAFT']['runPyHAMS']:
                            print('Found existing potential model: {}\n    - Trying to use this instead of running PyHAMS.'.format(potpath))
                            self.modeling_options['RAFT']['runPyHAMS'] = False
                        if osp.exists( potpath+'.1' ):
                            self.modeling_options["OpenFAST"]["HydroDyn"]["PotFile"] = osp.realpath(potpath)
                        elif osp.exists( osp.join(cwd, potpath+'.1') ):
                            self.modeling_options["OpenFAST"]["HydroDyn"]["PotFile"] = osp.realpath( osp.join(cwd, potpath) )
                        elif osp.exists( osp.join(weis_dir, potpath+'.1') ):
                            self.modeling_options["OpenFAST"]["HydroDyn"]["PotFile"] = osp.realpath( osp.join(weis_dir, potpath) )
                        elif osp.exists( osp.join(mod_opt_dir, potpath+'.1') ):
                            self.modeling_options["OpenFAST"]["HydroDyn"]["PotFile"] = osp.realpath( osp.join(mod_opt_dir, potpath) )
                        else:
                            raise Exception(f'No valid Wamit-style output found for specified PotFile option, {potpath}.1')

        # OpenFAST dir
        if self.modeling_options["OpenFAST"]["from_openfast"]:
            if not osp.isabs(self.modeling_options['OpenFAST']['openfast_dir']):
                # Make relative to modeling options input
                self.modeling_options['OpenFAST']['openfast_dir'] = osp.realpath(osp.join(
                    mod_opt_dir, self.modeling_options['OpenFAST']['openfast_dir'] ))
        
        # BEM dir, all levels
        base_run_dir = os.path.join(mod_opt_dir,self.modeling_options['General']['openfast_configuration']['OF_run_dir'])
        if MPI:
            rank    = MPI.COMM_WORLD.Get_rank()
            bemDir = osp.join(base_run_dir,'rank_%000d'%int(rank),'BEM')
        else:
            bemDir = osp.join(base_run_dir,'BEM')

        self.modeling_options["Level1"]['BEM_dir'] = bemDir
        if MPI:
            # If running MPI, RAFT won't be able to save designs in parallel
            self.modeling_options["Level1"]['save_designs'] = False
        
        # RAFT
        if self.modeling_options["flags"]["floating"]:
            bool_init = True if self.modeling_options["RAFT"]["potential_model_override"]==2 else False
            self.modeling_options["RAFT"]["model_potential"] = [bool_init] * self.modeling_options["floating"]["members"]["n_members"]

            if self.modeling_options["RAFT"]["potential_model_override"] == 0:
                for k in self.modeling_options["RAFT"]["potential_bem_members"]:
                    idx = self.modeling_options["floating"]["members"]["name"].index(k)
                    self.modeling_options["RAFT"]["model_potential"][idx] = True
        elif self.modeling_options["flags"]["offshore"]:
            self.modeling_options["RAFT"]["model_potential"] = [False]*1000
            
        # ROSCO
        self.modeling_options['ROSCO']['flag'] = (self.modeling_options['RAFT']['flag'] or
                                                  self.modeling_options['OpenFAST_Linear']['flag'] or
                                                  self.modeling_options['OpenFAST']['flag'])
        
        if self.modeling_options['ROSCO']['tuning_yaml'] != 'none':  # default is empty
            # Make path absolute if not, relative to modeling options input
            if not osp.isabs(self.modeling_options['ROSCO']['tuning_yaml']):
                self.modeling_options['ROSCO']['tuning_yaml'] = osp.realpath(osp.join(
                    mod_opt_dir, self.modeling_options['ROSCO']['tuning_yaml'] ))
                
        # Apply tuning yaml input if available, this needs to be here for sizing tune_rosco_ivc
        if os.path.split(self.modeling_options['ROSCO']['tuning_yaml'])[1] != 'none':  # default is none
            inps = load_rosco_yaml(self.modeling_options['ROSCO']['tuning_yaml'])  # tuning yaml validated in here
            self.modeling_options['ROSCO'].update(inps['controller_params'])

            # Apply changes in modeling options, should have already been validated
            modopts_no_defaults = load_yaml(self.modeling_options['fname_input_modeling'])  
            skip_options = ['tuning_yaml']  # Options to skip loading, tuning_yaml path has been updated, don't overwrite
            for option, value in modopts_no_defaults['ROSCO'].items():
                if option not in skip_options:
                    self.modeling_options['ROSCO'][option] = value
        
        # XFoil
        if not osp.isfile(self.modeling_options['OpenFAST']["xfoil"]["path"]) and self.modeling_options['ROSCO']['Flp_Mode']:
            raise Exception("A distributed aerodynamic control device is defined in the geometry yaml, but the path to XFoil in the modeling options is not defined correctly")

        # Compute the number of DLCs that will be run
        DLCs = self.modeling_options['DLC_driver']['DLCs']
        # Initialize the DLC generator
        cut_in = self.wt_init['control']['supervisory']['Vin']
        cut_out = self.wt_init['control']['supervisory']['Vout']
        metocean = self.modeling_options['DLC_driver']['metocean_conditions']
        dlc_driver_options = self.modeling_options['DLC_driver']
        dlc_generator = DLCGenerator(cut_in, cut_out, dlc_driver_options=dlc_driver_options, metocean=metocean)
        # Generate cases from user inputs
        for i_DLC in range(len(DLCs)):
            DLCopt = DLCs[i_DLC]
            dlc_generator.generate(DLCopt['DLC'], DLCopt)
        self.modeling_options['DLC_driver']['n_cases'] = dlc_generator.n_cases
        
        # Determine wind speeds that will be used to calculate AEP (using DLC AEP or 1.1)
        DLCs = [i_dlc['DLC'] for i_dlc in self.modeling_options['DLC_driver']['DLCs']]
        if 'AEP' in DLCs:
            DLC_label_for_AEP = 'AEP'
        else:
            DLC_label_for_AEP = '1.1'
        dlc_aep_ws = [c.URef for c in dlc_generator.cases if c.label == DLC_label_for_AEP]
        self.modeling_options['DLC_driver']['n_ws_aep'] = len(np.unique(dlc_aep_ws))

        # TMD modeling
        self.modeling_options['flags']['TMDs'] = False
        if 'TMDs' in self.wt_init:
            if self.modeling_options['OpenFAST']['flag']:
                self.modeling_options['flags']['TMDs'] = True
            else:
                raise Exception("TMDs in Levels 1 and 2 are not supported yet")


    def set_openmdao_vectors_control(self):
        # Distributed aerodynamic control devices along blade
        self.modeling_options['WISDEM']['RotorSE']['n_te_flaps']      = 0
        if 'aerodynamic_control' in self.wt_init['components']['blade']:
            if 'te_flaps' in self.wt_init['components']['blade']['aerodynamic_control']:
                self.modeling_options['WISDEM']['RotorSE']['n_te_flaps'] = len(self.wt_init['components']['blade']['aerodynamic_control']['te_flaps'])
                self.modeling_options['WISDEM']['RotorSE']['n_tab']   = 3
            else:
                raise Exception('A distributed aerodynamic control device is provided in the yaml input file, but not supported by wisdem.')

        if 'TMDs' in self.wt_init:
            n_TMDs = len(self.wt_init['TMDs'])
            self.modeling_options['TMDs'] = {}
            self.modeling_options['TMDs']['n_TMDs']                 = n_TMDs
            # TODO: come back and check how many of these need to be modeling options
            self.modeling_options['TMDs']['name']                   = [tmd['name'] for  tmd in self.wt_init['TMDs']]
            self.modeling_options['TMDs']['component']              = [tmd['component'] for  tmd in self.wt_init['TMDs']]
            self.modeling_options['TMDs']['location']               = [tmd['location'] for  tmd in self.wt_init['TMDs']]
            self.modeling_options['TMDs']['mass']                   = [tmd['mass'] for  tmd in self.wt_init['TMDs']]
            self.modeling_options['TMDs']['stiffness']              = [tmd['stiffness'] for  tmd in self.wt_init['TMDs']]
            self.modeling_options['TMDs']['damping']                = [tmd['damping'] for  tmd in self.wt_init['TMDs']]
            self.modeling_options['TMDs']['natural_frequency']      = [tmd['natural_frequency'] for  tmd in self.wt_init['TMDs']]
            self.modeling_options['TMDs']['damping_ratio']          = [tmd['damping_ratio'] for  tmd in self.wt_init['TMDs']]
            self.modeling_options['TMDs']['X_DOF']                  = [tmd['X_DOF'] for  tmd in self.wt_init['TMDs']]
            self.modeling_options['TMDs']['Y_DOF']                  = [tmd['Y_DOF'] for  tmd in self.wt_init['TMDs']]
            self.modeling_options['TMDs']['Z_DOF']                  = [tmd['Z_DOF'] for  tmd in self.wt_init['TMDs']]
            self.modeling_options['TMDs']['preload_spring']         = [tmd['preload_spring'] for  tmd in self.wt_init['TMDs']]

            # Check that TMD locations map to somewhere valid (tower or platform member)
            self.modeling_options['TMDs']['num_tower_TMDs'] = 0
            self.modeling_options['TMDs']['num_ptfm_TMDs']  = 0
            
            for i_TMD, component in enumerate(self.modeling_options['TMDs']['component']):
                if self.modeling_options['flags']['floating'] and component in self.modeling_options['floating']['members']['name']:
                    self.modeling_options['TMDs']['num_ptfm_TMDs'] += 1
                elif component == 'tower':
                    self.modeling_options['TMDs']['num_tower_TMDs'] += 1
                else:
                    raise Exception('Invalid TMD component mapping for {} on {}'.format(
                        self.modeling_options['TMDs']['name'][i_TMD],component))      

            # Set TMD group  mapping: list of length n_groups, with i_TMDs in each group
            # Loop through TMD names, assign to own group if not in an analysis group
            if 'TMDs' in self.analysis_options['design_variables']:
                tmd_group_map = []
                tmd_names = self.modeling_options['TMDs']['name']
                
                for i_group, tmd_group in enumerate(self.analysis_options['design_variables']['TMDs']['groups']):
                    tmds_in_group_i = [tmd_names.index(tmd_name) for tmd_name in tmd_group['names']]

                    tmd_group_map.append(tmds_in_group_i)
                
                self.modeling_options['TMDs']['group_mapping'] = tmd_group_map

    def update_ontology_control(self, wt_opt):
        # Update controller
        if self.modeling_options['flags']['control']:
            self.wt_init['control']['pitch']['omega_pc'] = wt_opt['tune_rosco_ivc.omega_pc']
            self.wt_init['control']['pitch']['zeta_pc']  = wt_opt['tune_rosco_ivc.zeta_pc']
            self.wt_init['control']['torque']['omega_vs'] = float(wt_opt['tune_rosco_ivc.omega_vs'])
            self.wt_init['control']['torque']['zeta_vs']  = float(wt_opt['tune_rosco_ivc.zeta_vs'])
            self.wt_init['control']['pitch']['Kp_float']  = float(wt_opt['tune_rosco_ivc.Kp_float'])
            self.wt_init['control']['pitch']['ptfm_freq']  = float(wt_opt['tune_rosco_ivc.ptfm_freq'])
            self.wt_init['control']['IPC']['IPC_Ki_1P'] = float(wt_opt['tune_rosco_ivc.IPC_Kp1p'])
            self.wt_init['control']['IPC']['IPC_Kp_1P'] = float(wt_opt['tune_rosco_ivc.IPC_Ki1p'])
            if self.modeling_options['ROSCO']['Flp_Mode'] > 0:
                self.wt_init['control']['dac']['flp_kp_norm']= float(wt_opt['tune_rosco_ivc.flp_kp_norm'])
                self.wt_init['control']['dac']['flp_tau'] = float(wt_opt['tune_rosco_ivc.flp_tau'])


    def write_options(self, fname_output):
        # Override the WISDEM version to ensure that the WEIS options files are written instead
        sch.write_modeling_yaml(self.modeling_options, fname_output)
        sch.write_analysis_yaml(self.analysis_options, fname_output)


    def backwards_compatibility(self):

        modopts_no_defaults = load_yaml(self.modeling_options['fname_input_modeling'])

        if 'Level1' in modopts_no_defaults:
            self.modeling_options['RAFT'] = copy.deepcopy(self.modeling_options['Level1'])
            logger.warning('Level1 is no longer a WEIS modeling option.  Please use RAFT instead.  Level1 will be depreciated in a future release.')

        if 'Level2' in modopts_no_defaults:
            self.modeling_options['OpenFAST_Linear'] = copy.deepcopy(self.modeling_options['Level2'])
            logger.warning('Level2 is no longer a WEIS modeling option.  Please use OpenFAST_Linear instead.  Level2 will be depreciated in a future release.')

        if 'Level3' in modopts_no_defaults:
            self.modeling_options['OpenFAST'] = copy.deepcopy(self.modeling_options['Level3'])
            logger.warning('Level3 is no longer a WEIS modeling option.  Please use OpenFAST instead.  Level3 will be depreciated in a future release.')



1	import os	1✔
2	import os.path as osp	1✔
3	import copy, logging	1✔
4	import numpy as np	1✔
5
6	from rosco import discon_lib_path	1✔
7	import weis.inputs as sch	1✔
8	from openfast_io.FAST_reader import InputReader_OpenFAST	1✔
9	from wisdem.glue_code.gc_LoadInputs import WindTurbineOntologyPython	1✔
10	from weis.dlc_driver.dlc_generator import DLCGenerator	1✔
11	from openmdao.utils.mpi import MPI	1✔
12	from rosco.toolbox.inputs.validation import load_rosco_yaml	1✔
13	from wisdem.inputs import load_yaml	1✔
14
15	logger = logging.getLogger("wisdem/weis")	1✔
16
17	def update_options(options,override):	1✔
18	for key, value in override.items():	1✔
19	if isinstance(value, dict) and key in options:	1✔
20	update_options(options[key], value)	1✔
21	elif key in options:	1✔
22	options[key] = value	1✔
23	else:
24	raise Exception(f'Error updating option overrides. {key} is not part of {options.keys()}')	×
25
26	class WindTurbineOntologyPythonWEIS(WindTurbineOntologyPython):	1✔
27	# Pure python class inheriting the class WindTurbineOntologyPython from WISDEM
28	# and adding the WEIS options, namely the paths to the WEIS submodules
29	# (OpenFAST, ROSCO, TurbSim, XFoil) and initializing the control parameters.
30
31	def __init__(	1✔
32	self,
33	fname_input_wt,
34	fname_input_modeling,
35	fname_input_analysis,
36	modeling_override = None,
37	analysis_override = None,
38	):
39
40	self.modeling_options = sch.load_modeling_yaml(fname_input_modeling)	1✔
41	self.modeling_options['fname_input_modeling'] = fname_input_modeling	1✔
42	self.wt_init = sch.load_geometry_yaml(fname_input_wt)	1✔
43	self.analysis_options = sch.load_analysis_yaml(fname_input_analysis)	1✔
44	self.analysis_options['fname_input_analysis'] = fname_input_analysis	1✔
45
46	# Update options to maintain some backwards compatibility
47	self.backwards_compatibility()	1✔
48
49	if modeling_override:	1✔
50	update_options(self.modeling_options, modeling_override)	1✔
51	sch.re_validate_modeling(self.modeling_options)	1✔
52
53
54	if analysis_override:	1✔
55	update_options(self.analysis_options, analysis_override)	×
56	sch.re_validate_analysis(self.analysis_options)	×
57
58	self.set_run_flags()	1✔
59	self.set_openmdao_vectors()	1✔
60	self.set_openmdao_vectors_control()	1✔
61	self.set_weis_data()	1✔
62	self.set_opt_flags()	1✔
63
64	def set_weis_data(self):	1✔
65
66	# Directory of modeling option input, if we want to use it for relative paths
67	mod_opt_dir = osp.split(self.modeling_options['fname_input_modeling'])[0]	1✔
68
69	# OpenFAST prefixes
70	if self.modeling_options['General']['openfast_configuration']['OF_run_fst'] in ['','None','NONE','none']:	1✔
71	self.modeling_options['General']['openfast_configuration']['OF_run_fst'] = 'weis_job'	1✔
72
73	if self.modeling_options['General']['openfast_configuration']['OF_run_dir'] in ['','None','NONE','none']:	1✔
74	self.modeling_options['General']['openfast_configuration']['OF_run_dir'] = osp.join(	1✔
75	mod_opt_dir, # If it's a relative path, will be relative to mod_opt directory
76	self.analysis_options['general']['folder_output'],
77	'openfast_runs'
78	)
79
80	# BEM dir, all levels
81	base_run_dir = os.path.join(mod_opt_dir,self.modeling_options['General']['openfast_configuration']['OF_run_dir'])	1✔
82	if MPI:	1✔
83	rank = MPI.COMM_WORLD.Get_rank()	×
84	bemDir = osp.join(base_run_dir,'rank_%000d'%int(rank),'BEM')	×
85	else:
86	bemDir = osp.join(base_run_dir,'BEM')	1✔
87
88	self.modeling_options["RAFT"]['BEM_dir'] = bemDir	1✔
89	if MPI:	1✔
90	# If running MPI, RAFT won't be able to save designs in parallel
NEW 91	self.modeling_options["RAFT"]['save_designs'] = False	×
92
93
94	# Openfast
95	if self.modeling_options['OpenFAST_Linear']['flag'] or self.modeling_options['OpenFAST']['flag']:	1✔
96	fast = InputReader_OpenFAST()	1✔
97	self.modeling_options['General']['openfast_configuration']['fst_vt'] = {}	1✔
98	self.modeling_options['General']['openfast_configuration']['fst_vt']['outlist'] = fast.fst_vt['outlist']	1✔
99
100
101	# User-defined control dylib (path2dll)
102	path2dll = self.modeling_options['General']['openfast_configuration']['path2dll']	1✔
103	if path2dll == 'none': #Default option, use above	1✔
104	self.modeling_options['General']['openfast_configuration']['path2dll'] = discon_lib_path	1✔
105	else:
106	if not osp.isabs(path2dll): # make relative path absolute	×
107	self.modeling_options['General']['openfast_configuration']['path2dll'] = \	×
108	osp.join(osp.dirname(self.options['modeling_options']['fname_input_modeling']), path2dll)
109	path2dll = self.modeling_options['General']['openfast_configuration']['path2dll']	1✔
110	if not osp.exists( path2dll ):	1✔
111	raise NameError("Cannot find DISCON library: "+path2dll)	×
112
113	# Activate HAMS in RAFT if requested for OpenFAST
114	if self.modeling_options["flags"]["offshore"] or self.modeling_options["OpenFAST"]["from_openfast"]:	1✔
115	if self.modeling_options["RAFT"]["potential_model_override"] == 2:	1✔
116	self.modeling_options["OpenFAST"]["HydroDyn"]["PotMod"] = 1	1✔
117	elif ( (self.modeling_options["RAFT"]["potential_model_override"] == 0) and	1✔
118	(len(self.modeling_options["RAFT"]["potential_bem_members"]) > 0) ):
NEW 119	self.modeling_options["OpenFAST"]["HydroDyn"]["PotMod"] = 1	×
120	elif self.modeling_options["RAFT"]["potential_model_override"] == 1:	1✔
NEW 121	self.modeling_options["OpenFAST"]["HydroDyn"]["PotMod"] = 0	×
122	else:
123	# Keep user defined value of PotMod
124	pass	1✔
125
126	if self.modeling_options["OpenFAST"]["HydroDyn"]["PotMod"] == 1:	1✔
127
128	# If user requested PotMod but didn't specify any override or members, just run everything
129	if ( (self.modeling_options["RAFT"]["potential_model_override"] == 0) and	1✔
130	(len(self.modeling_options["RAFT"]["potential_bem_members"]) == 0) ):
NEW 131	self.modeling_options["RAFT"]["potential_model_override"] == 2	×
132
133	cwd = os.getcwd()	1✔
134	weis_dir = osp.dirname(osp.dirname(osp.dirname(osp.abspath(__file__))))	1✔
135	potpath = self.modeling_options["OpenFAST"]["HydroDyn"]["PotFile"].replace('.hst','').replace('.12','').replace('.3','').replace('.1','')	1✔
136	if ( (len(potpath) == 0) or (potpath.lower() in ['unused','default','none']) ):	1✔
137
NEW 138	self.modeling_options['RAFT']['flag'] = True	×
NEW 139	self.modeling_options["OpenFAST"]["HydroDyn"]["PotFile"] = osp.join(bemDir,'Output','Wamit_format','Buoy')	×
140
141
142	else:
143	if self.modeling_options['RAFT']['runPyHAMS']:	1✔
144	print('Found existing potential model: {}\n - Trying to use this instead of running PyHAMS.'.format(potpath))	1✔
145	self.modeling_options['RAFT']['runPyHAMS'] = False	1✔
146	if osp.exists( potpath+'.1' ):	1✔
147	self.modeling_options["OpenFAST"]["HydroDyn"]["PotFile"] = osp.realpath(potpath)	1✔
148	elif osp.exists( osp.join(cwd, potpath+'.1') ):	×
NEW 149	self.modeling_options["OpenFAST"]["HydroDyn"]["PotFile"] = osp.realpath( osp.join(cwd, potpath) )	×
150	elif osp.exists( osp.join(weis_dir, potpath+'.1') ):	×
NEW 151	self.modeling_options["OpenFAST"]["HydroDyn"]["PotFile"] = osp.realpath( osp.join(weis_dir, potpath) )	×
152	elif osp.exists( osp.join(mod_opt_dir, potpath+'.1') ):	×
NEW 153	self.modeling_options["OpenFAST"]["HydroDyn"]["PotFile"] = osp.realpath( osp.join(mod_opt_dir, potpath) )	×
154	else:
155	raise Exception(f'No valid Wamit-style output found for specified PotFile option, {potpath}.1')	×
156
157	# OpenFAST dir
158	if self.modeling_options["OpenFAST"]["from_openfast"]:	1✔
159	if not osp.isabs(self.modeling_options['OpenFAST']['openfast_dir']):	1✔
160	# Make relative to modeling options input
161	self.modeling_options['OpenFAST']['openfast_dir'] = osp.realpath(osp.join(	1✔
162	mod_opt_dir, self.modeling_options['OpenFAST']['openfast_dir'] ))
163
164	# BEM dir, all levels
165	base_run_dir = os.path.join(mod_opt_dir,self.modeling_options['General']['openfast_configuration']['OF_run_dir'])	1✔
166	if MPI:	1✔
NEW 167	rank = MPI.COMM_WORLD.Get_rank()	×
NEW 168	bemDir = osp.join(base_run_dir,'rank_%000d'%int(rank),'BEM')	×
169	else:
170	bemDir = osp.join(base_run_dir,'BEM')	1✔
171
172	self.modeling_options["Level1"]['BEM_dir'] = bemDir	1✔
173	if MPI:	1✔
174	# If running MPI, RAFT won't be able to save designs in parallel
NEW 175	self.modeling_options["Level1"]['save_designs'] = False	×
176
177	# RAFT
178	if self.modeling_options["flags"]["floating"]:	1✔
179	bool_init = True if self.modeling_options["RAFT"]["potential_model_override"]==2 else False	1✔
180	self.modeling_options["RAFT"]["model_potential"] = [bool_init] * self.modeling_options["floating"]["members"]["n_members"]	1✔
181
182	if self.modeling_options["RAFT"]["potential_model_override"] == 0:	1✔
183	for k in self.modeling_options["RAFT"]["potential_bem_members"]:	1✔
184	idx = self.modeling_options["floating"]["members"]["name"].index(k)	1✔
185	self.modeling_options["RAFT"]["model_potential"][idx] = True	1✔
186	elif self.modeling_options["flags"]["offshore"]:	1✔
187	self.modeling_options["RAFT"]["model_potential"] = [False]*1000	1✔
188
189	# ROSCO
190	self.modeling_options['ROSCO']['flag'] = (self.modeling_options['RAFT']['flag'] or	1✔
191	self.modeling_options['OpenFAST_Linear']['flag'] or
192	self.modeling_options['OpenFAST']['flag'])
193
194	if self.modeling_options['ROSCO']['tuning_yaml'] != 'none': # default is empty	1✔
195	# Make path absolute if not, relative to modeling options input
196	if not osp.isabs(self.modeling_options['ROSCO']['tuning_yaml']):	1✔
197	self.modeling_options['ROSCO']['tuning_yaml'] = osp.realpath(osp.join(	1✔
198	mod_opt_dir, self.modeling_options['ROSCO']['tuning_yaml'] ))
199
200	# Apply tuning yaml input if available, this needs to be here for sizing tune_rosco_ivc
201	if os.path.split(self.modeling_options['ROSCO']['tuning_yaml'])[1] != 'none': # default is none	1✔
202	inps = load_rosco_yaml(self.modeling_options['ROSCO']['tuning_yaml']) # tuning yaml validated in here	1✔
203	self.modeling_options['ROSCO'].update(inps['controller_params'])	1✔
204
205	# Apply changes in modeling options, should have already been validated
206	modopts_no_defaults = load_yaml(self.modeling_options['fname_input_modeling'])	1✔
207	skip_options = ['tuning_yaml'] # Options to skip loading, tuning_yaml path has been updated, don't overwrite	1✔
208	for option, value in modopts_no_defaults['ROSCO'].items():	1✔
209	if option not in skip_options:	1✔
210	self.modeling_options['ROSCO'][option] = value	1✔
211
212	# XFoil
213	if not osp.isfile(self.modeling_options['OpenFAST']["xfoil"]["path"]) and self.modeling_options['ROSCO']['Flp_Mode']:	1✔
214	raise Exception("A distributed aerodynamic control device is defined in the geometry yaml, but the path to XFoil in the modeling options is not defined correctly")	×
215
216	# Compute the number of DLCs that will be run
217	DLCs = self.modeling_options['DLC_driver']['DLCs']	1✔
218	# Initialize the DLC generator
219	cut_in = self.wt_init['control']['supervisory']['Vin']	1✔
220	cut_out = self.wt_init['control']['supervisory']['Vout']	1✔
221	metocean = self.modeling_options['DLC_driver']['metocean_conditions']	1✔
222	dlc_driver_options = self.modeling_options['DLC_driver']	1✔
223	dlc_generator = DLCGenerator(cut_in, cut_out, dlc_driver_options=dlc_driver_options, metocean=metocean)	1✔
224	# Generate cases from user inputs
225	for i_DLC in range(len(DLCs)):	1✔
226	DLCopt = DLCs[i_DLC]	1✔
227	dlc_generator.generate(DLCopt['DLC'], DLCopt)	1✔
228	self.modeling_options['DLC_driver']['n_cases'] = dlc_generator.n_cases	1✔
229
230	# Determine wind speeds that will be used to calculate AEP (using DLC AEP or 1.1)
231	DLCs = [i_dlc['DLC'] for i_dlc in self.modeling_options['DLC_driver']['DLCs']]	1✔
232	if 'AEP' in DLCs:	1✔
NEW 233	DLC_label_for_AEP = 'AEP'	×
234	else:
235	DLC_label_for_AEP = '1.1'	1✔
236	dlc_aep_ws = [c.URef for c in dlc_generator.cases if c.label == DLC_label_for_AEP]	1✔
237	self.modeling_options['DLC_driver']['n_ws_aep'] = len(np.unique(dlc_aep_ws))	1✔
238
239	# TMD modeling
240	self.modeling_options['flags']['TMDs'] = False	1✔
241	if 'TMDs' in self.wt_init:	1✔
242	if self.modeling_options['OpenFAST']['flag']:	1✔
243	self.modeling_options['flags']['TMDs'] = True	1✔
244	else:
245	raise Exception("TMDs in Levels 1 and 2 are not supported yet")	×
246
247
248	def set_openmdao_vectors_control(self):	1✔
249	# Distributed aerodynamic control devices along blade
250	self.modeling_options['WISDEM']['RotorSE']['n_te_flaps'] = 0	1✔
251	if 'aerodynamic_control' in self.wt_init['components']['blade']:	1✔
252	if 'te_flaps' in self.wt_init['components']['blade']['aerodynamic_control']:	×
253	self.modeling_options['WISDEM']['RotorSE']['n_te_flaps'] = len(self.wt_init['components']['blade']['aerodynamic_control']['te_flaps'])	×
254	self.modeling_options['WISDEM']['RotorSE']['n_tab'] = 3	×
255	else:
256	raise Exception('A distributed aerodynamic control device is provided in the yaml input file, but not supported by wisdem.')	×
257
258	if 'TMDs' in self.wt_init:	1✔
259	n_TMDs = len(self.wt_init['TMDs'])	1✔
260	self.modeling_options['TMDs'] = {}	1✔
261	self.modeling_options['TMDs']['n_TMDs'] = n_TMDs	1✔
262	# TODO: come back and check how many of these need to be modeling options
263	self.modeling_options['TMDs']['name'] = [tmd['name'] for tmd in self.wt_init['TMDs']]	1✔
264	self.modeling_options['TMDs']['component'] = [tmd['component'] for tmd in self.wt_init['TMDs']]	1✔
265	self.modeling_options['TMDs']['location'] = [tmd['location'] for tmd in self.wt_init['TMDs']]	1✔
266	self.modeling_options['TMDs']['mass'] = [tmd['mass'] for tmd in self.wt_init['TMDs']]	1✔
267	self.modeling_options['TMDs']['stiffness'] = [tmd['stiffness'] for tmd in self.wt_init['TMDs']]	1✔
268	self.modeling_options['TMDs']['damping'] = [tmd['damping'] for tmd in self.wt_init['TMDs']]	1✔
269	self.modeling_options['TMDs']['natural_frequency'] = [tmd['natural_frequency'] for tmd in self.wt_init['TMDs']]	1✔
270	self.modeling_options['TMDs']['damping_ratio'] = [tmd['damping_ratio'] for tmd in self.wt_init['TMDs']]	1✔
271	self.modeling_options['TMDs']['X_DOF'] = [tmd['X_DOF'] for tmd in self.wt_init['TMDs']]	1✔
272	self.modeling_options['TMDs']['Y_DOF'] = [tmd['Y_DOF'] for tmd in self.wt_init['TMDs']]	1✔
273	self.modeling_options['TMDs']['Z_DOF'] = [tmd['Z_DOF'] for tmd in self.wt_init['TMDs']]	1✔
274	self.modeling_options['TMDs']['preload_spring'] = [tmd['preload_spring'] for tmd in self.wt_init['TMDs']]	1✔
275
276	# Check that TMD locations map to somewhere valid (tower or platform member)
277	self.modeling_options['TMDs']['num_tower_TMDs'] = 0	1✔
278	self.modeling_options['TMDs']['num_ptfm_TMDs'] = 0	1✔
279
280	for i_TMD, component in enumerate(self.modeling_options['TMDs']['component']):	1✔
281	if self.modeling_options['flags']['floating'] and component in self.modeling_options['floating']['members']['name']:	1✔
282	self.modeling_options['TMDs']['num_ptfm_TMDs'] += 1	1✔
283	elif component == 'tower':	×
284	self.modeling_options['TMDs']['num_tower_TMDs'] += 1	×
285	else:
286	raise Exception('Invalid TMD component mapping for {} on {}'.format(	×
287	self.modeling_options['TMDs']['name'][i_TMD],component))
288
289	# Set TMD group mapping: list of length n_groups, with i_TMDs in each group
290	# Loop through TMD names, assign to own group if not in an analysis group
291	if 'TMDs' in self.analysis_options['design_variables']:	1✔
292	tmd_group_map = []	1✔
293	tmd_names = self.modeling_options['TMDs']['name']	1✔
294
295	for i_group, tmd_group in enumerate(self.analysis_options['design_variables']['TMDs']['groups']):	1✔
296	tmds_in_group_i = [tmd_names.index(tmd_name) for tmd_name in tmd_group['names']]	1✔
297
298	tmd_group_map.append(tmds_in_group_i)	1✔
299
300	self.modeling_options['TMDs']['group_mapping'] = tmd_group_map	1✔
301
302	def update_ontology_control(self, wt_opt):	1✔
303	# Update controller
304	if self.modeling_options['flags']['control']:	×
305	self.wt_init['control']['pitch']['omega_pc'] = wt_opt['tune_rosco_ivc.omega_pc']	×
306	self.wt_init['control']['pitch']['zeta_pc'] = wt_opt['tune_rosco_ivc.zeta_pc']	×
307	self.wt_init['control']['torque']['omega_vs'] = float(wt_opt['tune_rosco_ivc.omega_vs'])	×
308	self.wt_init['control']['torque']['zeta_vs'] = float(wt_opt['tune_rosco_ivc.zeta_vs'])	×
309	self.wt_init['control']['pitch']['Kp_float'] = float(wt_opt['tune_rosco_ivc.Kp_float'])	×
310	self.wt_init['control']['pitch']['ptfm_freq'] = float(wt_opt['tune_rosco_ivc.ptfm_freq'])	×
311	self.wt_init['control']['IPC']['IPC_Ki_1P'] = float(wt_opt['tune_rosco_ivc.IPC_Kp1p'])	×
312	self.wt_init['control']['IPC']['IPC_Kp_1P'] = float(wt_opt['tune_rosco_ivc.IPC_Ki1p'])	×
313	if self.modeling_options['ROSCO']['Flp_Mode'] > 0:	×
314	self.wt_init['control']['dac']['flp_kp_norm']= float(wt_opt['tune_rosco_ivc.flp_kp_norm'])	×
315	self.wt_init['control']['dac']['flp_tau'] = float(wt_opt['tune_rosco_ivc.flp_tau'])	×
316
317
318	def write_options(self, fname_output):	1✔
319	# Override the WISDEM version to ensure that the WEIS options files are written instead
320	sch.write_modeling_yaml(self.modeling_options, fname_output)	1✔
321	sch.write_analysis_yaml(self.analysis_options, fname_output)	1✔
322
323
324	def backwards_compatibility(self):	1✔
325
326	modopts_no_defaults = load_yaml(self.modeling_options['fname_input_modeling'])	1✔
327
328	if 'Level1' in modopts_no_defaults:	1✔
NEW 329	self.modeling_options['RAFT'] = copy.deepcopy(self.modeling_options['Level1'])	×
NEW 330	logger.warning('Level1 is no longer a WEIS modeling option. Please use RAFT instead. Level1 will be depreciated in a future release.')	×
331
332	if 'Level2' in modopts_no_defaults:	1✔
NEW 333	self.modeling_options['OpenFAST_Linear'] = copy.deepcopy(self.modeling_options['Level2'])	×
NEW 334	logger.warning('Level2 is no longer a WEIS modeling option. Please use OpenFAST_Linear instead. Level2 will be depreciated in a future release.')	×
335
336	if 'Level3' in modopts_no_defaults:	1✔
NEW 337	self.modeling_options['OpenFAST'] = copy.deepcopy(self.modeling_options['Level3'])	×
NEW 338	logger.warning('Level3 is no longer a WEIS modeling option. Please use OpenFAST instead. Level3 will be depreciated in a future release.')	×
339
340

WISDEM / WEIS / 13333083280

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous