Serac  0.1
Serac is an implicit thermal strucural mechanics simulation code.
Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
serac::input::CoefficientInputOptions Struct Reference

The information required from the input file for an mfem::(Vector)(Function)Coefficient. More...

#include <input.hpp>

Public Types

using VecFunc = std::function< void(const mfem::Vector &, double, mfem::Vector &)>
 The type for coefficient functions that are vector-valued.
 
using ScalarFunc = std::function< double(const mfem::Vector &, double)>
 The type for coefficient functions that are scalar-valued.
 

Public Member Functions

bool isVector () const
 Returns whether the contained function corresponds to a vector coefficient.
 
std::unique_ptr< mfem::VectorCoefficient > constructVector (const int dim=3) const
 Constructs a vector coefficient with the requested dimension.
 
std::unique_ptr< mfem::Coefficient > constructScalar () const
 Constructs a scalar coefficient.
 

Static Public Member Functions

static void defineInputFileSchema (axom::inlet::Container &container)
 Defines the input file schema on the provided inlet container.
 

Public Attributes

ScalarFunc scalar_function
 The scalar std::function corresponding to a function coefficient.
 
VecFunc vector_function
 The vector std::function corresponding to a function coefficient.
 
std::optional< double > scalar_constant
 The scalar constant associated with the coefficient.
 
std::optional< mfem::Vector > vector_constant
 The vector constant associated with the coefficient.
 
std::unordered_map< int, double > scalar_pw_const
 Scalar piecewise constant definition map.
 
std::unordered_map< int, mfem::Vector > vector_pw_const
 Vector piecewise constant definition map.
 
std::optional< int > component
 The component to which a scalar coefficient should be applied.
 

Detailed Description

The information required from the input file for an mfem::(Vector)(Function)Coefficient.

Definition at line 88 of file input.hpp.


The documentation for this struct was generated from the following files: