PolyFEM
Loading...
Searching...
No Matches
polyfem::varform::ScalarVarForm Class Reference

#include <ScalarVarForm.hpp>

Inheritance diagram for polyfem::varform::ScalarVarForm:
[legend]
Collaboration diagram for polyfem::varform::ScalarVarForm:
[legend]

Public Member Functions

std::string name () const override
 Get the name of the variational formulation.
 
void init (const std::string &formulation, const Units &units, const json &args, const std::string &out_path) override
 Initialize the variational formulation with the given parameters.
 
void save_json (const Eigen::MatrixXd &solution, std::ostream &out) const override
 Save the solution to a JSON file, for output purposes.
 
void export_data (const Eigen::MatrixXd &solution) const override
 
io::OutputSpace output_space () const override
 Get the output space of the variational formulation, for output purposes.
 
io::OutStatsData compute_errors (const Eigen::MatrixXd &solution) override
 Get the error statistics of the variational formulation, for output purposes.
 
void serialize_checkpoint (io::CheckpointWriter &writer, const Eigen::MatrixXd &solution, const io::CheckpointMetadata &metadata) const override
 
void deserialize_checkpoint (const io::CheckpointReader &reader, Eigen::MatrixXd &solution) override
 
std::vector< io::OutputField > output_fields (const io::OutputSample &sample, const Eigen::MatrixXd &solution, const io::OutputFieldOptions &options) const override
 Get the output fields of the variational formulation, for output purposes.
 
 VarForm (const io::ResourceIO &resources)
 
- Public Member Functions inherited from polyfem::varform::VarForm
 VarForm (const io::ResourceIO &resources)
 
virtual ~VarForm ()=default
 
void set_args (const json &args)
 Reset the internal state of the variational formulation, e.g.
 
void set_checkpoint_reader (const io::CheckpointReader &reader)
 
void set_mesh (std::unique_ptr< mesh::Mesh > mesh, const double loading_mesh_time=0)
 Set the mesh for the variational formulation.
 
void set_geometry (mesh::LoadedGeometry geometry, double loading_mesh_time=0)
 
void solve (Eigen::MatrixXd &sol, const InitialConditionOverride *initial_condition_override=nullptr, const ForwardStepCallback &post_step={})
 Solve the variational formulation and store the solution in the given matrix.
 
void set_time_callback (const std::function< void(int, int, double, double)> &callback)
 
int problem_dimension () const
 Get the problem dimension of the variational formulation, for output purposes.
 
virtual bool is_contact_enabled () const
 Check if contact is enabled for the variational formulation, for output purposes.
 
const io::OutRuntimeData & output_timings () const
 Get the runtime timings of the variational formulation, for output purposes.
 
void save_json (const Eigen::MatrixXd &solution) const
 Save the solution to a JSON file, for output purposes.
 

Protected Member Functions

void reset () override
 
void load_mesh (const mesh::Mesh &mesh, const json &args) override
 
void build_basis (mesh::Mesh &mesh, const bool iso_parametric, const json &args) override
 
void assemble_rhs (const mesh::Mesh &mesh) override
 
void assemble_mass_mat (const mesh::Mesh &mesh, const json &args) override
 
void build_rhs_assembler () override
 
void prepare_initial_solution (Eigen::MatrixXd &solution) const
 
void build_stiffness_mat (StiffnessMatrix &stiffness)
 
void solve_problem (Eigen::MatrixXd &sol, const InitialConditionOverride *initial_condition_override, const ForwardStepCallback &post_step) override
 
void solve_linear_system (const std::unique_ptr< polysolve::linear::Solver > &solver, StiffnessMatrix &A, Eigen::VectorXd &b, const bool compute_spectrum, Eigen::MatrixXd &sol)
 
void solve_linear_system_with_constraints (const std::unique_ptr< polysolve::linear::Solver > &solver, StiffnessMatrix &A, Eigen::VectorXd &b, const bool compute_spectrum, const QuadratureOrders &boundary_samples, const double time, Eigen::MatrixXd &sol)
 
void solve_static (Eigen::MatrixXd &sol, const ForwardStepCallback &post_step)
 
void solve_transient (Eigen::MatrixXd &sol, const ForwardStepCallback &post_step)
 
- Protected Member Functions inherited from polyfem::varform::VarForm
void prepare ()
 Prepare all discretization and assembly data without running a solve.
 
std::string resolve_output_path (const std::string &path) const
 
void set_materials (assembler::Assembler &assembler, const int size) const
 
void restore_checkpoint_integrator (const std::shared_ptr< time_integrator::ImplicitTimeIntegrator > &integrator, const std::string &group, double dt, const std::string &ordering, const FESpace &space, int block_size) const
 
void write_checkpoint_ordering (io::CheckpointWriter &writer, const std::string &name, const FESpace &space) const
 
void reorder_checkpoint_block (const io::CheckpointReader &reader, const std::string &name, const FESpace &space, int block_size, int row_offset, Eigen::MatrixXd &value) const
 
Eigen::VectorXi checkpoint_ordering (const FESpace &space) const
 
void validate_checkpoint_solution (const Eigen::MatrixXd &solution, int expected_rows) const
 
bool checkpoint_reorder_enabled () const
 
void assign_discr_orders (const json &space_args, const mesh::Mesh &mesh, Eigen::VectorXi &disc_orders, Eigen::VectorXi &disc_ordersq)
 
void assign_discr_orders (const json &space_args, const int fe_space_id, const mesh::Mesh &mesh, Eigen::VectorXi &disc_orders, Eigen::VectorXi &disc_ordersq)
 
QuadratureOrders n_boundary_samples (const int discr_order, const int discr_orderq, const int gdiscr_order) const
 
void build_fe_space (mesh::Mesh &mesh, const bool iso_parametric, const Eigen::VectorXi &disc_orders, const Eigen::VectorXi &disc_ordersq, const std::string &basis_type, const std::string &poly_basis_type, const assembler::Assembler &space_assembler, const int value_dim, const int quadrature_order, const int mass_quadrature_order, const bool use_corner_quadrature, const int n_harmonic_samples, const int integral_constraints, FESpace &space, VarFormBoundaryState &boundary, std::shared_ptr< GeometryMapping > geometry=nullptr)
 
virtual void set_obstacle (mesh::Obstacle &&obstacle)
 
void save_step_state (const double t0, const double dt, const int t, const Eigen::MatrixXd &solution, const time_integrator::ImplicitTimeIntegrator *time_integrator) const
 
void ensure_output_sampler () const
 
void save_timestep (const double time, const int t, const double t0, const double dt, const Eigen::MatrixXd &solution) const
 
bool save_timestep_to_vtm (const double time, const int t, const double dt, const Eigen::MatrixXd &solution, paraviewo::VTMWriter &vtm, const std::string &block_prefix) const
 
void save_subsolve (const int i, const int t, const Eigen::MatrixXd &solution) const
 
int output_file_index (const int t) const
 
void notify_time_step (const int t, const int time_steps, const double t0, const double dt) const
 
void init_child_varform (VarForm &child, const std::string &formulation, const Units &units, const json &args, const std::string &out_path) const
 
io::OutGeometryData::ExportOptions export_options (const io::OutputSpace &space) const
 
io::OutputFieldFunction output_field_function (const Eigen::MatrixXd &solution, const io::OutGeometryData::ExportOptions &opts) const
 

Protected Attributes

FESpace space_
 
VarFormBoundaryState boundary_
 
assembler::AssemblyValsCache ass_vals_cache_
 
assembler::AssemblyValsCache mass_ass_vals_cache_
 
assembler::AssemblyValsCache pure_mass_ass_vals_cache_
 
std::shared_ptr< assembler::RhsAssembler > rhs_assembler_
 
StiffnessMatrix mass_
 
StiffnessMatrix pure_mass_
 
double avg_mass_ = 0
 
Eigen::MatrixXd rhs_
 
std::shared_ptr< assembler::Assembler > primary_assembler_ = nullptr
 
std::shared_ptr< assembler::Mass > mass_assembler_ = nullptr
 
std::shared_ptr< assembler::HRZMass > pure_mass_assembler_ = nullptr
 
solver::SolveData solve_data_
 
double t0 = 0
 
int time_steps = 0
 
double dt = 0
 
std::shared_ptr< time_integrator::ImplicitTimeIntegrator > time_integrator
 
- Protected Attributes inherited from polyfem::varform::VarForm
std::shared_ptr< assembler::Problem > problem
 current problem, it contains rhs and bc
 
Units units
 
json args
 
io::OutStatsData stats
 
io::OutRuntimeData timings
 runtime statistics
 
std::string output_path
 
std::optional< std::reference_wrapper< const io::CheckpointReader > > checkpoint_reader_
 
std::unique_ptr< mesh::Mesh > mesh_
 
std::function< void(int, int, double, double)> time_callback
 
io::OutGeometryData output_geometry_
 
bool output_sampler_initialized_ = false
 
bool prepared_ = false
 
int output_index_offset_ = 0
 
const io::ResourceIO & resources_
 

Friends

class polyfem::test::VarFormTestAccess
 

Additional Inherited Members

- Static Protected Member Functions inherited from polyfem::varform::VarForm
static void rebuild_node_positions (const std::vector< basis::ElementBases > &bases, const std::vector< int > &node_ids, std::vector< RowVectorNd > &positions)
 

Detailed Description

Definition at line 17 of file ScalarVarForm.hpp.

Member Function Documentation

◆ assemble_mass_mat()

◆ assemble_rhs()

void polyfem::varform::ScalarVarForm::assemble_rhs ( const mesh::Mesh &  mesh)
overrideprotectedvirtual

◆ build_basis()

void polyfem::varform::ScalarVarForm::build_basis ( mesh::Mesh &  mesh,
const bool  iso_parametric,
const json &  args 
)
overrideprotectedvirtual

Implements polyfem::varform::VarForm.

Definition at line 133 of file ScalarVarForm.cpp.

References polyfem::varform::VarForm::args, ass_vals_cache_, polyfem::varform::VarForm::assign_discr_orders(), polyfem::varform::FESpace::basis_list(), boundary_, polyfem::varform::VarFormBoundaryState::boundary_nodes, polyfem::varform::VarForm::build_fe_space(), polyfem::varform::VarFormBoundaryState::clear_boundary_conditions(), polyfem::io::OutStatsData::compute_mesh_size(), polyfem::io::OutStatsData::count_flipped_elements(), polyfem::assembler::Dirichlet, polyfem::varform::VarFormBoundaryState::dirichlet_nodes, polyfem::varform::VarFormBoundaryState::dirichlet_nodes_position, polyfem::varform::FESpace::geometry_basis_list(), polyfem::mesh::Mesh::get_node_id(), polyfem::assembler::AssemblyValsCache::init(), polyfem::assembler::AssemblyValsCache::init_empty(), polyfem::mesh::Mesh::is_volume(), polyfem::varform::VarFormBoundaryState::local_boundary, polyfem::varform::VarFormBoundaryState::local_neumann_boundary, polyfem::logger(), mass_ass_vals_cache_, mass_assembler_, polyfem::io::OutStatsData::mesh_size, polyfem::varform::FESpace::n_bases, polyfem::io::OutStatsData::n_flipped, polyfem::assembler::Neumann, polyfem::varform::VarFormBoundaryState::neumann_nodes, polyfem::varform::VarFormBoundaryState::neumann_nodes_position, polyfem::varform::VarFormBoundaryState::normalize_boundary_nodes(), polyfem::refinement::APriori::p_refine(), primary_assembler_, polyfem::varform::VarForm::problem, pure_mass_ass_vals_cache_, pure_mass_assembler_, polyfem::varform::VarForm::rebuild_node_positions(), space_, polyfem::varform::FESpace::space_in_node_to_node, polyfem::varform::VarForm::stats, polyfem::varform::VarFormBoundaryState::total_local_boundary, and polyfem::mesh::Mesh::update_nodes().

Here is the call graph for this function:

◆ build_rhs_assembler()

void polyfem::varform::ScalarVarForm::build_rhs_assembler ( )
overrideprotectedvirtual

◆ build_stiffness_mat()

void polyfem::varform::ScalarVarForm::build_stiffness_mat ( StiffnessMatrix &  stiffness)
protected

Definition at line 682 of file ScalarVarForm.cpp.

References polyfem::logger(), space_, and polyfem::varform::internal::write_matrix_market().

Here is the call graph for this function:

◆ compute_errors()

io::OutStatsData polyfem::varform::ScalarVarForm::compute_errors ( const Eigen::MatrixXd &  solution)
overridevirtual

Get the error statistics of the variational formulation, for output purposes.

Returns
Error statistics

Implements polyfem::varform::VarForm.

Definition at line 413 of file ScalarVarForm.cpp.

References polyfem::varform::VarForm::args, polyfem::varform::FESpace::basis_list(), polyfem::io::OutStatsData::compute_errors(), polyfem::varform::FESpace::geometry_basis_list(), polyfem::varform::VarForm::mesh_, polyfem::varform::FESpace::n_bases, polyfem::varform::VarForm::problem, space_, and polyfem::varform::VarForm::stats.

Here is the call graph for this function:

◆ deserialize_checkpoint()

void polyfem::varform::ScalarVarForm::deserialize_checkpoint ( const io::CheckpointReader &  reader,
Eigen::MatrixXd &  solution 
)
overridevirtual

Reimplemented from polyfem::varform::VarForm.

Definition at line 52 of file ScalarVarForm.cpp.

References polyfem::varform::VarForm::deserialize_checkpoint(), polyfem::varform::FESpace::ndof(), polyfem::varform::VarForm::reorder_checkpoint_block(), space_, and polyfem::varform::VarForm::validate_checkpoint_solution().

Here is the call graph for this function:

◆ export_data()

◆ init()

void polyfem::varform::ScalarVarForm::init ( const std::string &  formulation,
const Units &  units,
const json &  args,
const std::string &  out_path 
)
overridevirtual

Initialize the variational formulation with the given parameters.

Parameters
formulationname of the variational formulation
unitsunit system to use for the formulation
argsjson input arguments, used to initialize the formulation
out_pathoutput path for the formulation, used to save intermediate data

Reimplemented from polyfem::varform::VarForm.

Definition at line 84 of file ScalarVarForm.cpp.

References polyfem::varform::VarForm::args, dt, polyfem::problem::ProblemFactory::factory(), polyfem::problem::ProblemFactory::get_problem(), polyfem::varform::VarForm::init(), polyfem::assembler::AssemblerUtils::make_assembler(), mass_assembler_, primary_assembler_, polyfem::varform::VarForm::problem, pure_mass_assembler_, polyfem::varform::VarForm::resources_, t0, time_steps, and polyfem::varform::VarForm::units.

Here is the call graph for this function:

◆ load_mesh()

void polyfem::varform::ScalarVarForm::load_mesh ( const mesh::Mesh &  mesh,
const json &  args 
)
overrideprotectedvirtual

Implements polyfem::varform::VarForm.

Definition at line 124 of file ScalarVarForm.cpp.

References mass_assembler_, primary_assembler_, polyfem::varform::VarForm::problem, pure_mass_assembler_, and polyfem::varform::VarForm::set_materials().

Here is the call graph for this function:

◆ name()

std::string polyfem::varform::ScalarVarForm::name ( ) const
inlineoverridevirtual

Get the name of the variational formulation.

Returns
Name of the variational formulation

Implements polyfem::varform::VarForm.

Definition at line 23 of file ScalarVarForm.hpp.

Referenced by polyfem::varform::DifferentiableScalarVarForm::name(), and save_json().

Here is the caller graph for this function:

◆ output_fields()

std::vector< io::OutputField > polyfem::varform::ScalarVarForm::output_fields ( const io::OutputSample &  sample,
const Eigen::MatrixXd &  solution,
const io::OutputFieldOptions &  options 
) const
overridevirtual

◆ output_space()

io::OutputSpace polyfem::varform::ScalarVarForm::output_space ( ) const
overridevirtual

Get the output space of the variational formulation, for output purposes.

Returns
Output space

Implements polyfem::varform::VarForm.

Definition at line 388 of file ScalarVarForm.cpp.

References boundary_, polyfem::varform::VarFormBoundaryState::dirichlet_nodes, polyfem::varform::VarFormBoundaryState::dirichlet_nodes_position, polyfem::varform::FESpace::disc_orders, polyfem::varform::FESpace::disc_ordersq, polyfem::varform::FESpace::geometry_basis_list(), polyfem::varform::VarForm::mesh_, polyfem::varform::FESpace::polys, polyfem::varform::FESpace::polys_3d, space_, and polyfem::varform::VarFormBoundaryState::total_local_boundary.

Referenced by export_data(), and polyfem::varform::DifferentiableScalarVarForm::save_vtu().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ prepare_initial_solution()

void polyfem::varform::ScalarVarForm::prepare_initial_solution ( Eigen::MatrixXd &  solution) const
protected

Definition at line 345 of file ScalarVarForm.cpp.

References polyfem::varform::VarForm::problem, rhs_, and rhs_assembler_.

◆ reset()

void polyfem::varform::ScalarVarForm::reset ( )
overrideprotectedvirtual

◆ save_json()

void polyfem::varform::ScalarVarForm::save_json ( const Eigen::MatrixXd &  solution,
std::ostream &  out 
) const
overridevirtual

Save the solution to a JSON file, for output purposes.

Parameters
solutionSolution matrix to save
outOutput stream to save the solution

Implements polyfem::varform::VarForm.

Definition at line 359 of file ScalarVarForm.cpp.

References polyfem::varform::VarForm::args, polyfem::varform::FESpace::disc_orders, polyfem::varform::FESpace::disc_ordersq, polyfem::varform::FESpace::is_iso_parametric(), polyfem::logger(), polyfem::varform::VarForm::mesh_, polyfem::varform::FESpace::n_bases, name(), primary_assembler_, polyfem::varform::VarForm::problem, polyfem::io::OutStatsData::save_json(), space_, polyfem::varform::VarForm::stats, and polyfem::varform::VarForm::timings.

Here is the call graph for this function:

◆ serialize_checkpoint()

void polyfem::varform::ScalarVarForm::serialize_checkpoint ( io::CheckpointWriter &  writer,
const Eigen::MatrixXd &  solution,
const io::CheckpointMetadata &  metadata 
) const
overridevirtual

Reimplemented from polyfem::varform::VarForm.

Definition at line 43 of file ScalarVarForm.cpp.

References polyfem::varform::VarForm::serialize_checkpoint(), space_, and polyfem::varform::VarForm::write_checkpoint_ordering().

Here is the call graph for this function:

◆ solve_linear_system()

void polyfem::varform::ScalarVarForm::solve_linear_system ( const std::unique_ptr< polysolve::linear::Solver > &  solver,
StiffnessMatrix &  A,
Eigen::VectorXd &  b,
const bool  compute_spectrum,
Eigen::MatrixXd &  sol 
)
protected

Definition at line 704 of file ScalarVarForm.cpp.

References polyfem::logger(), space_, and x.

Here is the call graph for this function:

◆ solve_linear_system_with_constraints()

void polyfem::varform::ScalarVarForm::solve_linear_system_with_constraints ( const std::unique_ptr< polysolve::linear::Solver > &  solver,
StiffnessMatrix &  A,
Eigen::VectorXd &  b,
const bool  compute_spectrum,
const QuadratureOrders &  boundary_samples,
const double  time,
Eigen::MatrixXd &  sol 
)
protected

Definition at line 738 of file ScalarVarForm.cpp.

References entries, polyfem::solver::NLProblem::full_hessian_to_reduced_hessian(), polyfem::solver::NLProblem::full_to_reduced_grad(), polyfem::log_and_throw_error(), polyfem::logger(), polyfem::solver::NLProblem::reduced_size(), polyfem::solver::NLProblem::reduced_to_full(), space_, and weights.

Here is the call graph for this function:

◆ solve_problem()

void polyfem::varform::ScalarVarForm::solve_problem ( Eigen::MatrixXd &  sol,
const InitialConditionOverride *  initial_condition_override,
const ForwardStepCallback &  post_step 
)
overrideprotectedvirtual

Implements polyfem::varform::VarForm.

Definition at line 949 of file ScalarVarForm.cpp.

References polyfem::varform::InitialConditionOverride::acceleration, polyfem::logger(), POLYFEM_SCOPED_TIMER, polyfem::varform::InitialConditionOverride::solution, space_, and polyfem::varform::InitialConditionOverride::velocity.

Here is the call graph for this function:

◆ solve_static()

void polyfem::varform::ScalarVarForm::solve_static ( Eigen::MatrixXd &  sol,
const ForwardStepCallback &  post_step 
)
protected

Definition at line 851 of file ScalarVarForm.cpp.

References polyfem::logger(), and space_.

Here is the call graph for this function:

◆ solve_transient()

void polyfem::varform::ScalarVarForm::solve_transient ( Eigen::MatrixXd &  sol,
const ForwardStepCallback &  post_step 
)
protected

Definition at line 889 of file ScalarVarForm.cpp.

References polyfem::time_integrator::ImplicitTimeIntegrator::construct_bdf_integrator(), polyfem::logger(), and space_.

Here is the call graph for this function:

◆ VarForm()

polyfem::varform::VarForm::VarForm ( const io::ResourceIO &  resources)
inlineexplicit

Definition at line 60 of file VarForm.hpp.

Friends And Related Symbol Documentation

◆ polyfem::test::VarFormTestAccess

friend class polyfem::test::VarFormTestAccess
friend

Definition at line 19 of file ScalarVarForm.hpp.

Member Data Documentation

◆ ass_vals_cache_

assembler::AssemblyValsCache polyfem::varform::ScalarVarForm::ass_vals_cache_
protected

◆ avg_mass_

double polyfem::varform::ScalarVarForm::avg_mass_ = 0
protected

Definition at line 56 of file ScalarVarForm.hpp.

Referenced by assemble_mass_mat(), and reset().

◆ boundary_

VarFormBoundaryState polyfem::varform::ScalarVarForm::boundary_
protected

◆ dt

double polyfem::varform::ScalarVarForm::dt = 0
protected

◆ mass_

StiffnessMatrix polyfem::varform::ScalarVarForm::mass_
protected

◆ mass_ass_vals_cache_

assembler::AssemblyValsCache polyfem::varform::ScalarVarForm::mass_ass_vals_cache_
protected

◆ mass_assembler_

std::shared_ptr<assembler::Mass> polyfem::varform::ScalarVarForm::mass_assembler_ = nullptr
protected

◆ primary_assembler_

std::shared_ptr<assembler::Assembler> polyfem::varform::ScalarVarForm::primary_assembler_ = nullptr
protected

◆ pure_mass_

StiffnessMatrix polyfem::varform::ScalarVarForm::pure_mass_
protected

Definition at line 55 of file ScalarVarForm.hpp.

Referenced by reset().

◆ pure_mass_ass_vals_cache_

assembler::AssemblyValsCache polyfem::varform::ScalarVarForm::pure_mass_ass_vals_cache_
protected

Definition at line 52 of file ScalarVarForm.hpp.

Referenced by build_basis(), and reset().

◆ pure_mass_assembler_

std::shared_ptr<assembler::HRZMass> polyfem::varform::ScalarVarForm::pure_mass_assembler_ = nullptr
protected

Definition at line 61 of file ScalarVarForm.hpp.

Referenced by build_basis(), init(), load_mesh(), and reset().

◆ rhs_

Eigen::MatrixXd polyfem::varform::ScalarVarForm::rhs_
protected

Definition at line 57 of file ScalarVarForm.hpp.

Referenced by assemble_rhs(), prepare_initial_solution(), and reset().

◆ rhs_assembler_

◆ solve_data_

◆ space_

◆ t0

double polyfem::varform::ScalarVarForm::t0 = 0
protected

Definition at line 64 of file ScalarVarForm.hpp.

Referenced by init(), and reset().

◆ time_integrator

◆ time_steps

int polyfem::varform::ScalarVarForm::time_steps = 0
protected

Definition at line 65 of file ScalarVarForm.hpp.

Referenced by init(), and reset().


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