original_docstring: Build a report example.
  
      This function returns an instance of a simple report from a rotor
      example. The purpose of this is to make available a simple model
      so that doctest can be written using this.
  
      Returns
      -------
      An instance of a report object.
  
      Examples
      --------
      >>> import ross as rs
      >>> report = rs.report_example()
      >>> report.rotor_type
      'between_bearings'
      
docstring: Build a report example.
  This function returns an instance of a simple report from a rotor
  example. The purpose of this is to make available a simple model
  so that doctest can be written using this.
  
  Returns
  
  An instance of a report object.
  
  Examples
  
  
docstring_tokens: Build a report example . This function returns an instance of a simple report from a rotor example . The purpose of this is to make available a simple model so that doctest can be written using this . Returns An instance of a report object . Examples
code: def report_example():
      """Build a report example.
  
      This function returns an instance of a simple report from a rotor
      example. The purpose of this is to make available a simple model
      so that doctest can be written using this.
  
      Returns
      -------
      An instance of a report object.
  
      Examples
      --------
      >>> import ross as rs
      >>> report = rs.report_example()
      >>> report.rotor_type
      'between_bearings'
      """
      i_d = 0
      o_d = 0.05
      n = 6
      L = [0.25 for _ in range(n)]
  
      shaft_elem = [
          ShaftElement(
              l,
              i_d,
              o_d,
              material=steel,
              shear_effects=True,
              rotary_inertia=True,
              gyroscopic=True,
          )
          for l in L
      ]
  
      disk0 = DiskElement.from_geometry(
          n=2, material=steel, width=0.07, i_d=0.05, o_d=0.28
      )
      disk1 = DiskElement.from_geometry(
          n=4, material=steel, width=0.07, i_d=0.05, o_d=0.28
      )
  
      stfx = [0.4e7, 0.5e7, 0.6e7, 0.7e7]
      stfy = [0.8e7, 0.9e7, 1.0e7, 1.1e7]
      freq = [400, 800, 1200, 1600]
      bearing0 = BearingElement(0, kxx=stfx, kyy=stfy, cxx=2e3, frequency=freq)
      bearing1 = BearingElement(6, kxx=stfx, kyy=stfy, cxx=2e3, frequency=freq)
  
      rotor = Rotor(shaft_elem, [disk0, disk1], [bearing0, bearing1])
  
      # coefficients for minimum clearance
      stfx = [0.7e7, 0.8e7, 0.9e7, 1.0e7]
      dampx = [2.0e3, 1.9e3, 1.8e3, 1.7e3]
      freq = [400, 800, 1200, 1600]
      bearing0 = BearingElement(0, kxx=stfx, cxx=dampx, frequency=freq)
      bearing1 = BearingElement(6, kxx=stfx, cxx=dampx, frequency=freq)
      min_clearance_brg = [bearing0, bearing1]
  
      # coefficients for maximum clearance
      stfx = [0.4e7, 0.5e7, 0.6e7, 0.7e7]
      dampx = [2.8e3, 2.7e3, 2.6e3, 2.5e3]
      freq = [400, 800, 1200, 1600]
      bearing0 = BearingElement(0, kxx=stfx, cxx=dampx, frequency=freq)
      bearing1 = BearingElement(6, kxx=stfx, cxx=dampx, frequency=freq)
      max_clearance_brg = [bearing0, bearing1]
  
      bearings = [min_clearance_brg, max_clearance_brg]
      return Report(
          rotor=rotor,
          speed_range=(400, 1000),
          tripspeed=1200,
          bearing_stiffness_range=(5, 8),
          bearing_clearance_lists=bearings,
          speed_units="rad/s",
      )
code_tokens: def report_example ( ) : i_d = 0 o_d = 0.05 n = 6 L = [ 0.25 for _ in range ( n ) ] shaft_elem = [ ShaftElement ( l , i_d , o_d , material = steel , shear_effects = True , rotary_inertia = True , gyroscopic = True , ) for l in L ] disk0 = DiskElement . from_geometry ( n = 2 , material = steel , width = 0.07 , i_d = 0.05 , o_d = 0.28 ) disk1 = DiskElement . from_geometry ( n = 4 , material = steel , width = 0.07 , i_d = 0.05 , o_d = 0.28 ) stfx = [ 0.4e7 , 0.5e7 , 0.6e7 , 0.7e7 ] stfy = [ 0.8e7 , 0.9e7 , 1.0e7 , 1.1e7 ] freq = [ 400 , 800 , 1200 , 1600 ] bearing0 = BearingElement ( 0 , kxx = stfx , kyy = stfy , cxx = 2e3 , frequency = freq ) bearing1 = BearingElement ( 6 , kxx = stfx , kyy = stfy , cxx = 2e3 , frequency = freq ) rotor = Rotor ( shaft_elem , [ disk0 , disk1 ] , [ bearing0 , bearing1 ] ) stfx = [ 0.7e7 , 0.8e7 , 0.9e7 , 1.0e7 ] dampx = [ 2.0e3 , 1.9e3 , 1.8e3 , 1.7e3 ] freq = [ 400 , 800 , 1200 , 1600 ] bearing0 = BearingElement ( 0 , kxx = stfx , cxx = dampx , frequency = freq ) bearing1 = BearingElement ( 6 , kxx = stfx , cxx = dampx , frequency = freq ) min_clearance_brg = [ bearing0 , bearing1 ] stfx = [ 0.4e7 , 0.5e7 , 0.6e7 , 0.7e7 ] dampx = [ 2.8e3 , 2.7e3 , 2.6e3 , 2.5e3 ] freq = [ 400 , 800 , 1200 , 1600 ] bearing0 = BearingElement ( 0 , kxx = stfx , cxx = dampx , frequency = freq ) bearing1 = BearingElement ( 6 , kxx = stfx , cxx = dampx , frequency = freq ) max_clearance_brg = [ bearing0 , bearing1 ] bearings = [ min_clearance_brg , max_clearance_brg ] return Report ( rotor = rotor , speed_range = ( 400 , 1000 ) , tripspeed = 1200 , bearing_stiffness_range = ( 5 , 8 ) , bearing_clearance_lists = bearings , speed_units = "rad/s" , )
short_docstring: Build a report example.
short_docstring_tokens: Build a report example .
comment: """Build a report example.
  
      This function returns an instance of a simple report from a rotor
      example. The purpose of this is to make available a simple model
      so that doctest can be written using this.
  
      Returns
      -------
      An instance of a report object.
  
      Examples
      --------
      >>> import ross as rs
      >>> report = rs.report_example()
      >>> report.rotor_type
      'between_bearings'
      """$SEP$# coefficients for minimum clearance$SEP$# coefficients for maximum clearance