feat: add get and create methods and **kwargs support for create

doc/changelog.d/4866.added.md

@@ -0,0 +1 @@
+Add get and create methods and **kwargs support for create

doc/source/cheatsheet/cheat_sheet.qmd

@@ -63,14 +63,14 @@ session = pyfluent.Solver.from_connection(ip, port, password)
 ### File I/O
 
 ```{python}
-ReadCase(settings_source=solver)(
+ReadCase(solver)(
   file_name="<case_file>")
-ReadCaseData(settings_source=solver)(
+ReadCaseData(solver)(
   file_name="<data_file>")
 
-WriteCase(settings_source=solver)(
+WriteCase(solver)(
   file_name="<output_case_file>")
-WriteCaseData(settings_source=solver)(
+WriteCaseData(solver)(
   file_name="<output_case_file>")
 ```
 

doc/source/user_guide/fields/field_data.rst

@@ -47,7 +47,7 @@ To obtain surface vertex coordinates for a given surface, create a
   >>> from ansys.fluent.core.solver import VelocityInlet
 
   >>> vertices_request = SurfaceFieldDataRequest(
-  >>>     surfaces=[VelocityInlet(settings_source=solver_session, name="inlet")],
+  >>>     surfaces=[VelocityInlet(solver_session).get("inlet")],
   >>>     data_types=[SurfaceDataType.Vertices],
   >>> )
   >>> vertices_data = field_data.get_field_data(vertices_request)
@@ -66,7 +66,7 @@ in the ``data_types`` list.
 .. code-block:: python
 
   >>> faces_normal_and_centroid_request = SurfaceFieldDataRequest(
-  >>>     surfaces=[VelocityInlet(settings_source=solver_session, name="inlet")],
+  >>>     surfaces=[VelocityInlet(solver_session).get("inlet")],
   >>>     data_types=[SurfaceDataType.FacesNormal, SurfaceDataType.FacesCentroid],
   >>> )
   >>> faces_normal_and_centroid_data = field_data.get_field_data(faces_normal_and_centroid_request)
@@ -102,7 +102,7 @@ NGons (with more than 4 vertices).
 .. code-block:: python
 
   >>> faces_connectivity_request = SurfaceFieldDataRequest(
-  >>>     surfaces=[VelocityInlet(settings_source=solver_session, name="inlet")],
+  >>>     surfaces=[VelocityInlet(solver_session).get("inlet")],
   >>>     data_types=[SurfaceDataType.FacesConnectivity],
   >>>     flatten_connectivity=True,
   >>> )
@@ -130,7 +130,7 @@ To retrieve scalar field data, such as absolute pressure, use ``ScalarFieldDataR
 
   >>> absolute_pressure_request = ScalarFieldDataRequest(
   >>>     field_name=VariableCatalog.ABSOLUTE_PRESSURE,
-  >>>     surfaces=[VelocityInlet(settings_source=solver_session, name="inlet")],
+  >>>     surfaces=[VelocityInlet(solver_session).get("inlet")],
   >>> )
   >>> absolute_pressure_data = field_data.get_field_data(absolute_pressure_request)
 
@@ -152,7 +152,7 @@ To obtain vector field data, such as velocity vectors, use ``VectorFieldDataRequ
 
   >>> velocity_request = VectorFieldDataRequest(
   >>>     field_name=VariableCatalog.VELOCITY,
-  >>>     surfaces=VelocityInlets(settings_source=solver_session),
+  >>>     surfaces=VelocityInlets(solver_session).get("inlet"),
   >>> )
   >>> velocity_vector_data = field_data.get_field_data(velocity_request)
   # Shape: (262, 3) - Velocity vectors for 262 faces, each with components (vx, vy, vz) for 'inlet'.
@@ -171,7 +171,7 @@ To obtain pathlines field data, use ``PathlinesFieldDataRequest``:
   >>> from ansys.fluent.core import PathlinesFieldDataRequest
   >>> velocity_pathlines_request = PathlinesFieldDataRequest(
   >>>           field_name=VariableCatalog.VELOCITY_X,
-  >>>           surfaces=[VelocityInlet(settings_source=solver_session, name="inlet")]
+  >>>           surfaces=[VelocityInlet(solver_session).get("inlet")],
   >>>           flatten_connectivity=True,
   >>>       )
   >>> velocity_path_lines_data = field_data.get_field_data(velocity_pathlines_request)

doc/source/user_guide/fields/reduction.rst

@@ -54,7 +54,7 @@
   >>> # Compute the minimum of absolute pressure across multiple solvers
   >>> reduction.minimum(
     ...     expression=VariableCatalog.ABSOLUTE_PRESSURE,
-    ...     locations=VelocityInlets(settings_source=solver1) + VelocityInlets(settings_source=solver2),
+    ...     locations=VelocityInlets(solver1) + VelocityInlets(solver2),
     ... )
     101343.2241809384
 
@@ -80,14 +80,14 @@
 .. code-block:: python
 
   >>> from ansys.fluent.core.solver import VelocityInlet
-  >>> solver_session.fields.reduction.area(locations=[VelocityInlet(settings_source=solver_session, name="inlet1")])
+  >>> solver_session.fields.reduction.area(locations=[VelocityInlet(solver_session).get("inlet1")])
   0.002555675491754098
 
   >>> reduction.area(locations=["inlet1"], ctxt=solver_session)
   0.002555675491754098
 
 
 Reduction functions: capabilities
 ----------------------------------
 
 The following reduction functions are available in PyFluent:
@@ -301,7 +301,7 @@
 .. code-block:: python
 
   >>> cent = reduction.centroid(
-  >>>   locations=VelocityInlets(settings_source=solver1) + VelocityInlets(settings_source=solver2)
+  >>>   locations=VelocityInlets(solver1) + VelocityInlets(solver2)
   >>> )
   >>> cent.array
   (np.float64(-0.35755705583644837), np.float64(-0.1570620132480841), np.float64(-0.023607876218682954))

doc/source/user_guide/solver_settings/set_up/boundary_conditions.rst

@@ -13,7 +13,7 @@ Boundary conditions
     >>> file_name = examples.download_file("mixing_elbow.cas.h5", "pyfluent/mixing_elbow")
     >>> solver_session = pyfluent.launch_fluent()
     >>> solver_session.settings.file.read_case(file_name=file_name)
-    >>> cold_inlet = pyfluent.VelocityInlet(settings_source=solver_session, name="cold-inlet")
+    >>> cold_inlet = pyfluent.VelocityInlet(solver_session, name="cold-inlet")
     >>> cold_inlet.momentum.velocity.set_state(0.4)
     >>> inlet_turbulence = cold_inlet.turbulence
     >>> turbulence_specification = inlet_turbulence.turbulence_specification
@@ -33,5 +33,5 @@ Cell zone conditions
 
 .. code:: python
 
-    >>> elbow_fluid = pyfluent.solver.FluidCellZone(settings_source=solver_session, name="elbow-fluid")
+    >>> elbow_fluid = pyfluent.solver.FluidCellZone(solver_session, name="elbow-fluid")
     >>> elbow_fluid.laminar.set_state(True)

doc/source/user_guide/solver_settings/set_up/materials.rst

@@ -12,7 +12,7 @@ Copy material from database
     >>> file_name = examples.download_file("mixing_elbow.cas.h5", "pyfluent/mixing_elbow")
     >>> solver_session = pyfluent.launch_fluent()
     >>> solver_session.settings.file.read_case(file_name=file_name)
-    >>> materials = pyfluent.Materials(settings_source=solver_session)
+    >>> materials = pyfluent.Materials(solver_session)
     >>> fluids = materials.fluid
     >>> fluids.make_a_copy(from_="air",to="air-2")
     >>> air_copy = fluids["air-2"]
@@ -34,7 +34,7 @@ Copy material from database
      'sutherland',
      'kinetic-theory']
     >>> air_copy.viscosity.value.set_state(1.81e-05)
-    >>> elbow_fluid = pyfluent.solver.FluidCellZone(settings_source=solver_session, name="elbow-fluid")
+    >>> elbow_fluid = pyfluent.solver.FluidCellZone(solver_session, name="elbow-fluid")
     >>> elbow_fluid.material.set_state("air-2")
 
 

doc/source/user_guide/solver_settings/set_up/models/battery.rst

@@ -7,7 +7,7 @@ Setting up and querying the model
 .. code:: python
 
     >>> import ansys.fluent.core as pyfluent
-    >>> battery = pyfluent.solver.Battery(settings_source=solver_session)
+    >>> battery = pyfluent.solver.Battery(solver_session)
     >>> battery.enabled.set_state(True)
     >>> battery.solution_method.allowed_values()
     ['cht-coupling', 'fmu-cht-coupling', 'circuit-network', 'msmd', 'msmd-rom']

doc/source/user_guide/solver_settings/set_up/models/dpm.rst

@@ -7,7 +7,7 @@ Setting up and querying the model
 .. code:: python
 
     >>> import ansys.fluent.core as pyfluent
-    >>> dpm = pyfluent.solver.DiscretePhase(settings_source=solver_session)
+    >>> dpm = pyfluent.solver.DiscretePhase(solver_session)
     >>> dpm_models = dpm.physical_models
     >>> dpm_models.virtual_mass_force.enabled.get_state()
     >>> dpm_models.virtual_mass_force.virtual_mass_factor.is_active()

doc/source/user_guide/solver_settings/set_up/models/energy.rst

@@ -11,7 +11,7 @@ Setting up and querying the model
     >>> file_name = examples.download_file("mixing_elbow.cas.h5", "pyfluent/mixing_elbow")
     >>> solver_session = pyfluent.launch_fluent()
     >>> solver_session.settings.file.read_case(file_name=file_name)
-    >>> energy = pyfluent.solver.Energy(settings_source=solver_session)
+    >>> energy = pyfluent.solver.Energy(solver_session)
     >>> energy.enabled.get_state()
     True
     >>> from pprint import pprint

doc/source/user_guide/solver_settings/set_up/models/radiation.rst

@@ -7,7 +7,7 @@ Setting up and querying the model
 .. code:: python
 
     >>> import ansys.fluent.core as pyfluent
-    >>> radiation = pyfluent.solver.Radiation(settings_source=solver_session)
+    >>> radiation = pyfluent.solver.Radiation(solver_session)
     >>> from pprint import pprint
     >>> pprint(radiation.get_state(), width=1)
     {'model': 'none',

doc/source/user_guide/solver_settings/set_up/models/species.rst

@@ -9,7 +9,7 @@ Setting up and querying the model
     >>> import ansys.fluent.core as pyfluent
     >>> solver_session = pyfluent.launch_fluent()
     >>> solver_session.settings.file.read_case(file_name=file_name)
-    >>> species = pyfluent.solver.Species(settings_source=solver_session)
+    >>> species = pyfluent.solver.Species(solver_session)
     >>> species.get_state()
     {'model': {'option': 'off', 'number_vol_spec': False}}
     >>> from pprint import pprint

doc/source/user_guide/solver_settings/set_up/models/viscous.rst

@@ -7,7 +7,7 @@ Setting up and querying the model
 .. code:: python
 
     >>> import ansys.fluent.core as pyfluent
-    >>> viscous = pyfluent.solver.Viscous(settings_source=solver_session)
+    >>> viscous = pyfluent.solver.Viscous(solver_session)
     >>> from pprint import pprint
     >>> pprint(viscous.get_state(), width=1)
     {'k_omega_model': 'sst',

doc/source/user_guide/solver_settings/solution.rst

@@ -9,11 +9,11 @@ Steady or transient solution model
 
 .. code:: python
 
-  >>> setup = pyfluent.solver.Setup(settings_source=solver_session)
+  >>> setup = pyfluent.solver.Setup(solver_session)
   >>> solver_time = setup.general.solver.time
-  >>> solver_time.get_state()
+  >>> solver_time()
   'steady'
-  >>> solver_time.allowed_values()
+  >>> solver_time.all()
   ['steady', 'unsteady-1st-order']
   >>> solver_time.set_state("unsteady-1st-order")
 
@@ -23,39 +23,39 @@ Pressure-based or density-based solver
 
 .. code:: python
 
-  >>> setup = pyfluent.solver.Setup(settings_source=solver_session)
-  >>> solver_type = setup.general.solver.type
-  >>> solver_type.get_state()
+  >>> setup = pyfluent.solver.Setup(solver_session)
+  >>> solver = setup.general.solver
+  >>> solver.type()
   'pressure-based'
-  >>> solver_type.allowed_values()
+  >>> solver.type.all()
   ['pressure-based', 'density-based-implicit', 'density-based-explicit']
-  >>> solver_session.settings.setup.general.solver.type.set_state("density-based-explicit")
-  >>> solver_type.get_state()
+  >>> solver.type = "density-based-explicit"
+  >>> solver.type()
   'density-based-explicit'
 
 
 Velocity coupling scheme and gradient options
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-    
+
 .. code:: python
 
-  >>> methods = pyfluent.solver.Methods(settings_source=solver_session)
+  >>> methods = pyfluent.solver.Methods(solver_session)
   >>> flow_scheme = methods.p_v_coupling.flow_scheme
-  >>> flow_scheme.allowed_values()
+  >>> flow_scheme.all()
   ['SIMPLE', 'SIMPLEC', 'PISO', 'Coupled']
   >>> flow_scheme.set_state("Coupled")
   >>> gradient_scheme = methods.gradient_scheme
-  >>> gradient_scheme.allowed_values()
+  >>> gradient_scheme.all()
   ['green-gauss-node-based', 'green-gauss-cell-based', 'least-square-cell-based']
   >>> gradient_scheme.set_state("green-gauss-node-based")
 
 
-Solution controls 
+Solution controls
 ~~~~~~~~~~~~~~~~~
 
 .. code:: python
 
-  >>> controls = pyfluent.solver.Controls(settings_source=solver_session)
+  >>> controls = pyfluent.solver.Controls(solver_session)
   >>> p_v_controls = controls.p_v_controls
   >>> explicit_momentum_under_relaxation = p_v_controls.explicit_momentum_under_relaxation
   >>> explicit_momentum_under_relaxation.min()
@@ -75,16 +75,15 @@ Create a report definition
 
 .. code:: python
 
-  >>> rep_defs = pyfluent.solver.ReportDefinitions(settings_source=solver_session)
-  >>> surface_report_definitions = rep_defs.surface
-  >>> defn_name = "outlet-temp-avg"
-  >>> surface_report_definitions[defn_name] = {}
-  >>> outlet_temperature = surface_report_definitions[defn_name]
-  >>> outlet_temperature.report_type.set_state("surface-massavg")
-  >>> outlet_temperature.field.set_state("temperature")
+  >>> rep_defs = pyfluent.solver.ReportDefinitions(solver_session)
+  >>> outlet_temperature = rep_defs.surface.create(
+  ...     name="outlet-temp-avg",
+  ...     report_type="surface-massavg",
+  ...     field="temperature",
+  ... )
 
 
-Initialize and solve 
+Initialize and solve
 ~~~~~~~~~~~~~~~~~~~~
 
 .. code:: python