piglot

Examples

  • Curve Fitting
  • Response Design
  • Analytical Objectives
  • Post-processing results

Advanced Options

  • Solver Options

Input file templates

  • Input File Options
  • Optimiser options
  • Solver options

Reference

  • API
    • piglot.bin
    • piglot.objective
    • piglot.objectives
    • piglot.optimiser
    • piglot.optimisers
    • piglot.parameter
    • piglot.solver
      • piglot.solver.read_solver
      • piglot.solver.curve
      • piglot.solver.input_file_solver
      • piglot.solver.links
        • piglot.solver.links.fields
        • piglot.solver.links.solver
      • piglot.solver.multi_case_solver
      • piglot.solver.script_solver
      • piglot.solver.solver
    • piglot.utils
  • Integration with solvers
  • Papers
piglot
  • piglot
  • piglot.solver
  • piglot.solver.links
  • piglot.solver.links.solver
  • piglot.solver.links.solver.LinksCase
  • View page source

piglot.solver.links.solver.LinksCase

class LinksCase(name: str, fields: Dict[str, OutputField], generator: InputDataGenerator, links: str, mpi_command: str | None = None)[source]

Bases: InputFileCase

Class for Links cases.

Methods

get_dependencies

Get the dependencies for a given input file.

get_fields

Get the fields to output for this case.

get_supported_fields

Get the supported fields for this input file type.

name

Return the name of the case.

read

Read the case from the configuration dictionary.

run

Run the case for the given set of parameters.

classmethod get_dependencies(input_file: str) → Tuple[List[str], List[str]][source]

Get the dependencies for a given input file.

Parameters

input_filestr

Input file to check for dependencies.

Returns

Tuple[List[str], List[str]]

Substitution and copy dependencies for this input file.

get_fields() → List[str]

Get the fields to output for this case.

Returns

List[str]

Fields to output for this case.

classmethod get_supported_fields() → Dict[str, Type[OutputField]][source]

Get the supported fields for this input file type.

Returns

Dict[str, Type[OutputField]]

Names and supported fields for this input file type.

name() → str

Return the name of the case.

Returns

str

Name of the case.

classmethod read(name: str, config: Dict[str, Any]) → V

Read the case from the configuration dictionary.

Parameters

namestr

Name of the case.

configDict[str, Any]

Configuration dictionary.

Returns

InputFileCase

Case to use for this problem.

run(parameters: ParameterSet, values: ndarray, tmp_dir: str) → CaseResult

Run the case for the given set of parameters.

Parameters

parametersParameterSet

Parameter set for this problem.

valuesnp.ndarray

Current parameters to evaluate.

tmp_dirstr

Temporary directory to run the problem.

Returns

CaseResult

Result of the case.

Previous Next

© Copyright 2025, CM2S.

Built with Sphinx using a theme provided by Read the Docs.