Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

refactor: naming of modules #142

Open
wants to merge 8 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 10 additions & 12 deletions queens/data_processors/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -17,18 +17,16 @@
Modules for extracting and processing data from simulation output files.
"""

from queens.data_processors.csv import Csv
from queens.data_processors.ensight import Ensight
from queens.data_processors.ensight_interface import EnsightInterfaceDiscrepancy
from queens.data_processors.numpy import Numpy
from queens.data_processors.pvd import Pvd
from queens.data_processors.txt import Txt
from queens.data_processors.csv_file import CsvFile
from queens.data_processors.ensight_file import EnsightFile
from queens.data_processors.numpy_file import NumpyFile
from queens.data_processors.pvd_file import PvdFile
from queens.data_processors.txt_file import TxtFile

VALID_TYPES = {
"csv": Csv,
"ensight": Ensight,
"ensight_interface_discrepancy": EnsightInterfaceDiscrepancy,
"numpy": Numpy,
"pvd": Pvd,
"txt": Txt,
"csv": CsvFile,
"ensight": EnsightFile,
"numpy": NumpyFile,
"pvd": PvdFile,
"txt": TxtFile,
}
Original file line number Diff line number Diff line change
Expand Up @@ -19,14 +19,14 @@
import numpy as np
import pandas as pd

from queens.data_processors.data_processor import DataProcessor
from queens.data_processors._data_processor import DataProcessor
from queens.utils.logger_settings import log_init_args
from queens.utils.valid_options import get_option

_logger = logging.getLogger(__name__)


class Csv(DataProcessor):
class CsvFile(DataProcessor):
"""Class for extracting data from csv files.

Attributes:
Expand Down Expand Up @@ -100,7 +100,7 @@ def __init__(
The paths can contain regex expressions.

Returns:
Instance of Csv class
Instance of CsvFile class
"""
super().__init__(
file_name_identifier=file_name_identifier,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,13 +20,13 @@
import vtk
from vtkmodules.util.numpy_support import numpy_to_vtk, vtk_to_numpy

from queens.data_processors.data_processor import DataProcessor
from queens.data_processors._data_processor import DataProcessor
from queens.utils.logger_settings import log_init_args

_logger = logging.getLogger(__name__)


class Ensight(DataProcessor):
class EnsightFile(DataProcessor):
"""Class for data-processing ensight output.

Attributes:
Expand Down Expand Up @@ -83,9 +83,6 @@ def __init__(
The paths can contain regex expressions.
external_geometry (obj): QUEENS external geometry object
experimental_data_reader (obj): Experimental data reader object

Returns:
Instance of Ensight class (obj)
"""
super().__init__(
file_name_identifier=file_name_identifier,
Expand Down Expand Up @@ -313,7 +310,7 @@ def _get_data_from_experimental_coordinates(self, vtk_data_obj, time_value):
experimental_coordinates_for_snapshot, axis=1
)
# interpolate vtk solution to experimental coordinates
interpolated_data = Ensight._interpolate_vtk(
interpolated_data = EnsightFile._interpolate_vtk(
experimental_coordinates_for_snapshot,
vtk_data_obj,
self.vtk_array_type,
Expand Down Expand Up @@ -366,7 +363,7 @@ def _get_data_from_geometric_set(
]

# interpolate vtk solution to experimental coordinates
interpolated_data = Ensight._interpolate_vtk(
interpolated_data = EnsightFile._interpolate_vtk(
geometric_set_coordinates,
vtk_data_obj,
self.vtk_array_type,
Expand Down
Loading
Loading