Struct InputSchema 

pub struct InputSchema {
    pub gen_conf: GenConfig,
    pub meshes: IndexMap<String, MeshEnum>,
    pub equations: IndexMap<String, Equation>,
    pub parameters: IndexMap<String, QuantityEnum>,
    pub unknowns: IndexMap<String, Unknown>,
    pub functions: IndexMap<String, FunctionDef>,
    pub solve: Solve,
}

Hecate Input Schema

The input schema for Hecate.

Fields

gen_conf: GenConfig

meshes: IndexMap<String, MeshEnum>

Meshes

The available meshes.

equations: IndexMap<String, Equation>

Equations

The available equations.

parameters: IndexMap<String, QuantityEnum>

Parameters

The available parameters.

unknowns: IndexMap<String, Unknown>

Unknowns

The available unknowns.

functions: IndexMap<String, FunctionDef>

Functions

The available functions. They can either be simple function expression, or a list of function expression with conditions.

solve: Solve

Implementations

impl InputSchema

pub fn from_yaml(yaml: &str) -> Result<Self, Error>

impl InputSchema

pub fn validate(&self) -> Result<(), SchemaValidationError>

pub fn generate_sources(&self) -> Result<CodeGenRes, CodeGenError>

Examples found in repository

examples/heat-eq.rs (line 12)

fn main() -> Result<()> {
    env_logger::builder()
        .filter_level(log::LevelFilter::Info)
        .parse_default_env()
        .init();
    let schema: InputSchema =
        serde_yaml::from_str(include_str!("../input-schemas/heat-eq.hecate.yml"))?;

    let sources = schema.generate_sources()?;

    sources.write_to_dir("build/example-heat-eq")?;

    Ok(())
}

examples/wave-eq.rs (line 13)

fn main() -> Result<()> {
    env_logger::builder()
        .filter_level(log::LevelFilter::Info)
        .format_timestamp(None)
        .parse_default_env()
        .init();
    let schema: InputSchema =
        serde_yaml::from_str(include_str!("../input-schemas/wave-eq.hecate.yml"))?;

    let res = schema.generate_sources()?;

    res.write_to_dir("build/example-wave-eq")?;

    Ok(())
}

pub fn generate_cpp_sources(&self) -> Result<String, CodeGenError>

Trait Implementations

impl Clone for InputSchema

fn clone(&self) -> InputSchema

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for InputSchema

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for InputSchema

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for InputSchema

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl Serialize for InputSchema

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.